docs: refresh cli page #9274
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis update reorganizes and expands the Langflow documentation for CLI commands and environment variables. It revises option defaults, clarifies command usage, updates variable defaults, and improves descriptions. The placement of the Changes
Sequence Diagram(s)Not applicable; changes are documentation-only. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
github-actions
Bot
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docs/docs/Configuration/api-keys-and-authentication.mdx (1)
162-166: Use lowercase booleans for consistency with the rest of the docsEvery other Boolean default in the configuration docs is shown as
true/false, but this paragraph uses capitalisedTrue/False. Stick to the same lowercase form to avoid confusing readers.-Controls the availability of the `langflow superuser` command in the Langflow CLI. -The default is `True`, but `False` is recommended to prevent unrestricted superuser creation. +Controls the availability of the `langflow superuser` command in the Langflow CLI. +The default is `true`, but `false` is recommended to prevent unrestricted superuser creation.docs/docs/Configuration/environment-variables.mdx (1)
151-156: Defaults in the table no longer match the examples belowThe table now says
LANGFLOW_MAX_FILE_SIZE_UPLOADdefault100(Line 173)LANGFLOW_LOG_LEVELdefaultcritical(Line 171)LANGFLOW_WORKER_TIMEOUTdefault300(Line 199)…but the
.envexample (Lines 79-109) and other code samples still use10000,error, and60000respectively. Align these values or add a note explaining the difference, otherwise readers will not know which value actually applies.Also applies to: 160-173, 79-98
docs/docs/Configuration/configuration-cli.mdx (2)
38-40: Minor grammar + boolean-case fix-For example, if your set `LANGFLOW_REMOVE_API_KEYS=True` in your `.env` file, then you can change this to `False` by running the CLI with `--no-remove-api-keys`. +For example, if you set `LANGFLOW_REMOVE_API_KEYS=true` in your `.env` file, you can change this to `false` by running the CLI with `--no-remove-api-keys`.
198-202: Option defaults look offThe “Default” column shows
testandno-fix, which are flag names rather than boolean defaults. Usually you’d showtrue/false(or leave “Default” blank for false). Consider changing to:-| `--test` | `test` | Boolean | Run migrations in test mode. Use `--no-test` to disable test mode. | -| `--fix` | `no-fix` | Boolean | Fix migrations. This is a destructive operation, and all affected data will be deleted.| +| `--test / --no-test` | `true` | Boolean | Run migrations in test mode (default). | +| `--fix / --no-fix` | `false` | Boolean | Apply migrations (destructive). |
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/docs/Configuration/api-keys-and-authentication.mdx(1 hunks)docs/docs/Configuration/configuration-cli.mdx(5 hunks)docs/docs/Configuration/environment-variables.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/docs/**/*.{md,mdx}
📄 CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)
docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
Content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Files:
docs/docs/Configuration/api-keys-and-authentication.mdxdocs/docs/Configuration/environment-variables.mdxdocs/docs/Configuration/configuration-cli.mdx
🧠 Learnings (7)
📓 Common learnings
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
📚 Learning: applies to docs/docs/**/*.{md,mdx} : use consistent terminology: always capitalize langflow, compone...
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize Langflow, Component, Flow, and uppercase API and JSON.
Applied to files:
docs/docs/Configuration/api-keys-and-authentication.mdxdocs/docs/Configuration/environment-variables.mdxdocs/docs/Configuration/configuration-cli.mdx
📚 Learning: when writing documentation for langflow using docusaurus, always use professional but approachable t...
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Applied to files:
docs/docs/Configuration/environment-variables.mdxdocs/docs/Configuration/configuration-cli.mdx
📚 Learning: all terminology such as 'langflow', 'component', 'flow', 'api', and 'json' must be capitalized or up...
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
Applied to files:
docs/docs/Configuration/environment-variables.mdxdocs/docs/Configuration/configuration-cli.mdx
📚 Learning: in langflow mcp projects configuration, prefer using dynamically computed urls (like the `sse_url` v...
Learnt from: deon-sanchez
PR: langflow-ai/langflow#9158
File: src/backend/base/langflow/api/v1/mcp_projects.py:404-404
Timestamp: 2025-07-23T21:19:22.567Z
Learning: In langflow MCP projects configuration, prefer using dynamically computed URLs (like the `sse_url` variable) over hardcoded localhost URLs to ensure compatibility across different deployment environments.
Applied to files:
docs/docs/Configuration/environment-variables.mdx
📚 Learning: starter project files auto-format after langflow run; these formatting changes can be committed or i...
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/backend_development.mdc:0-0
Timestamp: 2025-07-18T18:25:54.486Z
Learning: Starter project files auto-format after langflow run; these formatting changes can be committed or ignored
Applied to files:
docs/docs/Configuration/environment-variables.mdx
📚 Learning: applies to src/backend/tests/**/*.py : test langflow's rest api endpoints in backend python tests us...
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-07-21T14:16:14.125Z
Learning: Applies to src/backend/tests/**/*.py : Test Langflow's REST API endpoints in backend Python tests using the async client fixture and asserting response codes and payloads.
Applied to files:
docs/docs/Configuration/configuration-cli.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Validate PR
- GitHub Check: build-and-deploy
|
Build successful! ✅ |
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
I think the page is a lot more informative and helpful. I like the use of tabs and the information you added at the beginning. Thanks for researching the commands and options.
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
removed
the
documentation
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
|
Build successful! ✅ |
* cli-values * split-out-introductory-commands * remove-feature-flag-envs * cleanup-cli-links * fix type * clarification-on-cli-superuser * remove-internal-env-vars * alignment and editorial * audit booleans --------- Co-authored-by: April M <april.murphy@datastax.com> Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
* cli-values * split-out-introductory-commands * remove-feature-flag-envs * cleanup-cli-links * fix type * clarification-on-cli-superuser * remove-internal-env-vars * alignment and editorial * audit booleans --------- Co-authored-by: April M <april.murphy@datastax.com> Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
* cli-values * split-out-introductory-commands * remove-feature-flag-envs * cleanup-cli-links * fix type * clarification-on-cli-superuser * remove-internal-env-vars * alignment and editorial * audit booleans --------- Co-authored-by: April M <april.murphy@datastax.com> Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
* cli-values * split-out-introductory-commands * remove-feature-flag-envs * cleanup-cli-links * fix type * clarification-on-cli-superuser * remove-internal-env-vars * alignment and editorial * audit booleans --------- Co-authored-by: April M <april.murphy@datastax.com> Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
2 participants
Refresh CLI page to ensure commands are still viable and clear.
Some work crossed over into the environment variables page also, which are updated with the default values and have the link-ids and outdated CLI links removed from the table.
Summary by CodeRabbit