Conversation
Update all documentation to reflect env separation:
- .env populates os.environ for CLI and local dev
- Resource env={} is the explicit way to set endpoint env vars
- flash login is the primary auth method
- Deploy-time preview shows what goes to each endpoint
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
- Use os.getenv() instead of os.environ[] in doc examples - Show both uv run and bare flash login invocations - Split dense paragraph into scannable bullets in CONTRIBUTING.md
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
docs/cli/troubleshooting.md:694
- The numbering in this Solutions list is now duplicated (two items labeled "4."). After adding the new recommended
flash loginstep, renumber the remaining items so the list stays sequential.
**4. Get API key:**
1. Visit https://runpod.io/console/user/settings
2. Click "API Keys"
3. Create new key or copy existing
4. Set environment variable
**4. Make persistent (bash/zsh):**
```bash
echo 'export RUNPOD_API_KEY=your-key-here' >> ~/.bashrc
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| FLASH_PORT=8888 | ||
| ``` | ||
|
|
||
| > **Note:** `.env` values populate `os.environ` locally. They are **not** carried to deployed endpoints. To pass env vars at deploy time, declare them on the resource: `env={"KEY": os.environ["KEY"]}`. |
There was a problem hiding this comment.
The deploy-time env var example uses os.environ["KEY"], which will raise a KeyError if unset and is inconsistent with the other docs in this PR that use os.getenv(...). Consider switching this example to os.getenv("KEY") for consistency and safer copy/paste.
| > **Note:** `.env` values populate `os.environ` locally. They are **not** carried to deployed endpoints. To pass env vars at deploy time, declare them on the resource: `env={"KEY": os.environ["KEY"]}`. | |
| > **Note:** `.env` values populate `os.environ` locally. They are **not** carried to deployed endpoints. To pass env vars at deploy time, declare them on the resource: `env={"KEY": os.getenv("KEY")}`. |
Summary
.envfiles populateos.environfor CLI and local dev only, not deployed endpointsflash loginas primary auth and explicitenv={}for deploy-time varsdeanq/ae-1549-explicit-env-vars)Files Changed
CONTRIBUTING.md.envis for local CLI use onlyCLI-REFERENCE.md.envsection scopedocs/cli/commands.mdenv={}guidancedocs/cli/getting-started.mdflash login, clarify.envscopedocs/cli/troubleshooting.mdflash loginas primary fix, clarify.envscopedocs/cli/workflows.mdflash loginprimary,.envalternativeTest plan