docs: add env var setup for macOS and Windows GUI

[italojohnny]

Adds guidance on how to set env vars for Langflow Desktop on macOS and Windows.

Summary by CodeRabbit

• Documentation
  • Added detailed instructions for setting environment variables for Langflow Desktop on macOS and Windows, including step-by-step guides and examples for both operating systems.
  • Updated installation documentation to clarify that environment variables set in the terminal are not automatically available to GUI applications and linked to the new environment variable setup guide.

[github-actions]

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

[github-actions]

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

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

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.

Walkthrough

The documentation was updated to add detailed instructions for setting environment variables specifically for the Langflow Desktop application on macOS and Windows. The new section explains the differences from terminal-based environment variables and provides step-by-step guidance for both operating systems. Additionally, the installation guide was updated to reference this new section.

Changes

File(s)	Change Summary
docs/docs/Configuration/environment-variables.md	Added a section detailing how to set environment variables for Langflow Desktop on macOS and Windows, including examples and step-by-step instructions.
docs/docs/Get-Started/get-started-installation.md	Updated installation guide to include a note about environment variables not being inherited by GUI apps and referenced the new environment variables section.

Poem

A rabbit with docs in its paws,
Hopped through the system’s hidden doors.
Now Mac and Windows, side by side,
Can set their vars with newfound pride.
With plist and PowerShell, the way is clear—
Hop on, set up, and bring Langflow near! 🐇✨

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch docs-gui-env-vars

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (5)

docs/docs/Configuration/environment-variables.md (5)

380-385: Consider adding an anchor for linkability
The new “Set environment variables for Langflow Desktop” section would benefit from a Docusaurus anchor (e.g., {#configure-variables-desktop}) so you can link directly to it from other docs or the TOC.

---

386-387: Add anchors to each OS subsection
To improve navigability, consider adding IDs to the macOS and Windows subsection headings, for example:

### Set environment variables for Langflow Desktop for macOS {#desktop-macos}  
### Set environment variables for Langflow Desktop on Windows {#desktop-windows}

This will let users link directly to platform-specific instructions.

Also applies to: 428-429

---

388-389: Fix spacing around inline code
There is a missing space before the backtick-wrapped filenames. For example:

- variables set in your terminal, such as`.zshrc` or `.bash_profile`
+ variables set in your terminal, such as `.zshrc` or `.bash_profile`

---

402-421: Suggest guidance on reloading updated plist entries
After you’ve created or modified the plist, it’s helpful to show how to reload it without a reboot. For example:

launchctl unload ~/Library/LaunchAgents/dev.langflow.env.plist
launchctl load   ~/Library/LaunchAgents/dev.langflow.env.plist

This ensures changes take effect immediately for GUI apps you’ve already launched.

---

442-442: Fix spacing around inline Windows path
Add a space before the backtick for consistency:

- value, such as`C:\Users\your_user\.langflow_config`
+ value, such as `C:\Users\your_user\.langflow_config`

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 70b8f29 and ba254bc.

📒 Files selected for processing (1)

• docs/docs/Configuration/environment-variables.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build-and-deploy

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (2)

docs/docs/Configuration/environment-variables.md (2)

379-384: Add cross-link from Desktop installation guide
Users installing Langflow Desktop may not discover this section. Consider adding a link or note in the Desktop install docs pointing to “Set environment variables for Langflow Desktop.”

---

379-384: Use Tabs for OS-specific sections
Rather than multiple subheadings, wrap the macOS, Windows, and PowerShell instructions in a <Tabs> component for cleaner UX and easier navigation.

🧹 Nitpick comments (2)

docs/docs/Configuration/environment-variables.md (2)

385-425: Fix spacing and clarify restart requirement

• Insert a space before backticks in “such as .zshrc or .bash_profile”.
• After launchctl load, note that GUI apps must be restarted (or user logged out/in) to pick up the new variables.

@@ 387
- If you're using macOS and want to configure environment variables for the Langflow Desktop version, it's important to know that variables set in your terminal, such as`.zshrc` or `.bash_profile`, are **not automatically available to GUI applications** like Langflow Desktop when launched through Finder or the Dock.
+ If you're using macOS and want to configure environment variables for the Langflow Desktop version, it's important to know that variables set in your terminal, such as `.zshrc` or `.bash_profile`, are **not automatically available to GUI applications** like Langflow Desktop when launched through Finder or the Dock.

@@ After line 425
+:::tip
+After loading your plist with `launchctl`, restart Langflow Desktop (or log out and back in) to apply the new environment variables.
+:::

---

427-445: Unify heading style & mention restart

• Change “Set environment variables for Langflow Desktop on Windows” to match macOS phrasing: e.g. “Set environment variables for Langflow Desktop on Windows.”
• Note that a restart (or sign-out/in) is required for GUI apps to inherit the new variables when set via System Properties.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ba254bc and cf850ab.

📒 Files selected for processing (1)

• docs/docs/Configuration/environment-variables.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build-and-deploy

🔇 Additional comments (1)

docs/docs/Configuration/environment-variables.md (1)

446-457: PowerShell examples are clear
The PowerShell commands correctly cover user and machine scopes and note the need to restart the application. No issues here.

[github-actions]

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

[github-actions]

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

[github-actions]

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

[github-actions]

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

[aimurphy]

A few things are a bit inconsistent (ex. random PowerShell tab with no second tab) and should be addressed, but most of my comments are optional. (For @mendonk )

[github-actions]

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

[github-actions]

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

[github-actions]

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