docs: clarify .env setup and troubleshoot ~/.local/bin/env errors#22
docs: clarify .env setup and troubleshoot ~/.local/bin/env errors#22sanjayy0612 wants to merge 2 commits intoNVIDIA-AI-Blueprints:mainfrom
Conversation
- Add clear explanation that .env goes in repo root only - Add collapsible troubleshooting section for first-time uv setup - Clarify difference between .env (API keys) and ~/.local/bin/env (uv PATH script) - Make setup.sh more robust with fallbacks for different uv install locations Fixes NVIDIA-AI-Blueprints#12
There was a problem hiding this comment.
Pull request overview
Updates onboarding documentation and the UV bootstrap script to reduce first-time setup confusion around .env placement and missing ~/.local/bin/env errors.
Changes:
- Clarify that
.env(API keys) must be created in the repository root. - Add a troubleshooting section explaining the
~/.local/bin/enverror and distinguishing.envvsenv. - Make
setup.shattempt multiple PATH/envfallbacks after installinguv.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
setup.sh |
Adds fallback logic to locate/source UV environment setup and verifies uv is on PATH after install. |
README.md |
Clarifies .env location and adds troubleshooting guidance for missing ~/.local/bin/env. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Install uv (creates ~/.local/bin/env automatically) | ||
| curl -LsSf https://astral.sh/uv/install.sh | sh | ||
|
|
||
| # Add uv to your PATH | ||
| source ~/.local/bin/env | ||
|
|
||
| # Now run make uv | ||
| make uv | ||
| ``` | ||
|
|
||
| **Alternative:** If `uv` is already installed via Homebrew or pipx, just ensure it's in your PATH. |
There was a problem hiding this comment.
The troubleshooting steps assume ~/.local/bin/env will exist after installing uv and instruct source ~/.local/bin/env, but setup.sh now supports other install locations (e.g., $HOME/.cargo/env) and a PATH fallback. To avoid users hitting the same error on those setups, update this section to mention the alternate file/location or instruct checking command -v uv and adding the appropriate bin directory to PATH.
…(prevents duplicate .env keys) - Change 'Directory' to 'directory' (lowercase) in error message - Improve PATH error message to mention multiple locations - Make curl | sh pipeline more robust with proper error handling Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Description
Clarifies the
.envfile setup instructions and adds troubleshooting for the~/.local/bin/enverror that confuses first-time users.Changes
.envgoes in repo root only~/.local/bin/enverror.env(API keys) vsenv(uv PATH script)setup.shmore robust with fallbacks for different uv install locationsRelated Issue
Fixes #12
Testing
make uvsuccessfully after following the updated instructions