Skip to content

docs: Clarify .env file scope in Flash documentation#562

Merged
muhsinking merged 1 commit intomainfrom
promptless/clarify-env-file-scope-flash
Mar 20, 2026
Merged

docs: Clarify .env file scope in Flash documentation#562
muhsinking merged 1 commit intomainfrom
promptless/clarify-env-file-scope-flash

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Mar 20, 2026

Open this suggestion in Promptless to view citations and reasoning process

Clarifies that .env files only work for local CLI commands and development—values are not passed to deployed endpoints. Updates login, parameters, troubleshooting, and local-testing docs to recommend flash login as primary auth and show how to use the env parameter to pass variables to deployed workers.

Trigger Events

Internal discussion about ensuring Flash documentation covers how .env files work, referencing a specific PR in the flash-examples repository.

Promptless Research (9 files, 1 GitHub PR)

  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed .long_term_context/style/client_style_guide.md
  • Reviewed runpod/flash-examples#39
  • Viewed flash/cli/env.mdx
  • Viewed flash/cli/login.mdx
  • Viewed flash/configuration/parameters.mdx
  • Viewed flash/quickstart.mdx
  • Viewed flash/apps/local-testing.mdx
  • Viewed flash/troubleshooting.mdx

Agent Response

I've created a documentation suggestion to clarify how .env files work in Flash. Here's a summary of the changes:

Summary

The Flash docs previously didn't explain a critical distinction: .env files only work for local CLI commands and development—they are NOT passed to deployed endpoints.

Changes made

1. flash/cli/login.mdx

  • Added a warning explaining that .env values are local-only
  • Added a link to the env parameter docs for passing variables to deployed endpoints

2. flash/configuration/parameters.mdx

  • Added a warning in the env parameter section explaining the .env vs env parameter distinction
  • Added a code example showing the pattern env={"HF_TOKEN": os.environ["HF_TOKEN"]} to pass local env vars to deployed workers

3. flash/troubleshooting.mdx

  • Added flash login as the recommended first option for authentication (previously only showed env var options)
  • Added a note clarifying .env scope in the API key troubleshooting section

4. flash/apps/local-testing.mdx

  • Added flash login as the recommended fix for authentication errors
  • Added a note clarifying .env scope

Suggestion created

The suggestion is ready for review at: https://app.gopromptless.ai/suggestions/cd666ef7-6632-4025-9345-de8f10388711


Tip: Assign suggestions to team members in the Promptless dashboard to claim work 👥


<Warning>
Your Runpod API key needs **All** access permissions to your Runpod account.
Values in your `.env` file are only used for local CLI commands and development. They are **not** passed to deployed endpoints. To set environment variables on deployed endpoints, use the `env` parameter in your endpoint configuration. See [Endpoint parameters](/flash/configuration/parameters#env) for details.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: Based on PR #39 which clarifies that .env files only populate os.environ for local CLI use—they are not carried to deployed endpoints. Key files: docs/cli/getting-started.md, docs/cli/workflows.md.
View source

@mintlify
Copy link

mintlify bot commented Mar 20, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Mar 20, 2026, 10:23 PM

```

<Warning>
Values in your project's `.env` file are only available locally for CLI commands and development. They are **not** passed to deployed endpoints. You must declare environment variables explicitly using the `env` parameter.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: Based on PR #39 which documents the pattern env={"KEY": os.environ["KEY"]} to pass local env vars to deployed endpoints. Key files: docs/cli/commands.md, docs/cli/workflows.md.
View source


**Option 3: Add to your shell profile (`~/.bashrc` or `~/.zshrc`) for global authorization**
<Note>
Values in your `.env` file are only available locally for CLI commands. They are not passed to deployed endpoints.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: Based on PR #39 which recommends flash login as primary auth method and clarifies .env scope. Key files: docs/cli/troubleshooting.md, docs/cli/getting-started.md.
View source

```

<Note>
Values in your `.env` file are only available locally for CLI commands. They are not passed to deployed endpoints.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: Based on PR #39 which clarifies .env scope for local development. Added flash login as recommended auth fix per the PR guidance.
View source

@promptless
Copy link
Contributor Author

promptless bot commented Mar 20, 2026

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

@muhsinking muhsinking merged commit 82d7383 into main Mar 20, 2026
3 checks passed
@muhsinking muhsinking deleted the promptless/clarify-env-file-scope-flash branch March 20, 2026 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant