Skip to content

docs: lfx engine feature#9378

Closed
mendonk wants to merge 6 commits into
docs-1.7-releasefrom
docs-lfx-engine
Closed

docs: lfx engine feature#9378
mendonk wants to merge 6 commits into
docs-1.7-releasefrom
docs-lfx-engine

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Aug 13, 2025

This pull request adds a guide for installing, configuring, and using LFX, including its two main commands (serve and run), and update the sidebar to include this new documentation page.

Some questions:

  1. Why does run not have a --env-file option? It seems it would be useful.
  2. More information on check/no-check global variables.
  3. Is there any way to manage the API key that lfx is using after it is declared, other than exporting another key?

#9133

@mendonk mendonk requested a review from ogabrielluiz August 13, 2025 14:24
@mendonk mendonk self-assigned this Aug 13, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 13, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-lfx-engine

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mendonk mendonk requested a review from aimurphy August 13, 2025 14:24
Comment thread docs/docs/Concepts/lfx-headless-runner.mdx
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 13, 2025
@sonarqubecloud
Copy link
Copy Markdown

@github-actions

This comment has been minimized.

@mendonk mendonk changed the title docs: lfx engine feature docs: 1.6 lfx engine feature Aug 13, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Aug 13, 2025
@mendonk mendonk added the DO NOT MERGE Don't Merge this PR label Aug 21, 2025
@mendonk mendonk marked this pull request as draft August 25, 2025 14:15
Comment thread docs/docs/Concepts/lfx-headless-runner.mdx
Comment thread docs/docs/Concepts/lfx-headless-runner.mdx
Comment thread docs/docs/Concepts/lfx-headless-runner.mdx
Comment thread docs/docs/Concepts/lfx-headless-runner.mdx

- [Python](https://www.python.org/downloads/release/python-3100/)
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
- A [flow JSON file](/concepts-flows)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- A [flow JSON file](/concepts-flows)
- A [flow JSON file](/concepts-flows-import)

| `--input-value` | Input value to pass to the graph (alternative to positional argument) |
| `--flow-json` | Inline JSON flow content as a string |
| `--stdin` | Read JSON flow from stdin |
| `--check-variables`/`--no-check-variables` | Check global variables for environment No newline at end of file
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the default?


### LFX run options

**Table: Command-line options for `lfx run`**
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Table: Command-line options for `lfx run`**

Redundant of line 123


**Table: Command-line options for `lfx run`**

| Option | Description |
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same comment as the other table: If you are only going to have two columns, I would just use a list.
Otherwise, I would suggest creating a 3rd column for the default values.

Comment thread docs/sidebars.js
{
type: "doc",
id: "Concepts/lfx-headless-runner",
label: "Run flows with Langflow Executor (LFX)"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am curious why you didn't put this with the other run flow options? It creates a disconnect that could confuse users.

Comment thread docs/docs/Concepts/lfx-headless-runner.mdx
@mendonk mendonk changed the title docs: 1.6 lfx engine feature docs: lfx engine feature Sep 17, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 17, 2025
@sonarqubecloud
Copy link
Copy Markdown

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 18, 2025
@github-actions

This comment has been minimized.

Base automatically changed from docs-1.6 to main September 26, 2025 14:15
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 26, 2025
* ci: publish v2 docker images

since or transition to v2 in 1.6.x we have not been publishing any of our docker images.

* chore: try fixing lfx cleanup error

lfx cleanup error

* chore: address rabbitcode comments

* chore: address rabit uv comment

* chore: remove build-args to see if it passes

* chore: skip ci

* chore: add back in LANGFLOW_IMAGE

* chore: debug inputs.ref and matrix.langflow_image

* chore: add {} to fix InvalidDefaultArgInForm

* chore: try adding  quotes

* chore: try ENV LANGFLOW_IMAGE=${LANGFLOW_IMAGE}

* chore: add build args to GitHub Container Registry

* chore: clean up

* chore: seperate out frontend and backend images

* chore: update create-manifest

* chore: remove ci step

* chore: update release

* chore: clean up

* chore: clean up langflow-image

* chore: revert ci removal

* fix: add back in main logic update back/frontend

add main back in
update back/frontend to match orginal man logic more

* chore: more clean up to match main

* chore: remove arch from lagnflowimage for backend

* chore: add misisng - for ghcr.io

* chore: skip ci

* chore: build_main and build_and_push_backend fixes

* chore: seperate ghcr and docker publishing with if

* chore: add back CI step

---------

Co-authored-by: Adam Aghili <Adam.Aghili@ibm.com>
@mendonk mendonk changed the base branch from main to docs-1.7-release November 3, 2025 18:14
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Nov 3, 2025
@github-actions

This comment has been minimized.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Nov 3, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@mendonk
Copy link
Copy Markdown
Collaborator Author

mendonk commented Nov 3, 2025

Superseded by #10081

@mendonk mendonk closed this Nov 3, 2025
@mendonk mendonk deleted the docs-lfx-engine branch November 4, 2025 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DO NOT MERGE Don't Merge this PR documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants