docs: point setup instructions at ~/.gcode/.env - #82
Merged
shauryagangrade merged 1 commit intoAug 14, 2026
Conversation
The README and CONTRIBUTING told users to copy .env.example to a project-root .env, but GCode only loads keys from ~/.gcode/.env (gcode/setup.py load_env). Align the Setup section, the Quick Setup commands, and the .env.example header comment with the path the app actually reads. The missing-key error already points at ~/.gcode/.env. Fixes shauryagangrade#52.
shauryagangrade
marked this pull request as ready for review
August 14, 2026 17:42
Owner
|
Merged. Thanks for your work here. If you would like to contribute to more repos just like this, I recommend: https://github.com/shauryagangrade/intent-drift-skill |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #52.
Problem
The README "Setup" section (and CONTRIBUTING.md Quick Setup) told users to copy
.env.exampleto a project-root.env, but GCode only loads API keys from~/.gcode/.env(gcode/setup.pyload_env()). Users who follow the README verbatim hit "No API key provided" at startup.Change
Chose the docs option from the issue: the app's env location stays
~/.gcode/.env(already referenced by the missing-key error ingcode/errors.py), and all user-facing setup docs are aligned with it:README.mdSetup:mkdir -p ~/.gcode && cp .env.example ~/.gcode/.env, then edit~/.gcode/.env.CONTRIBUTING.mdQuick Setup: same commands and prose..env.example: header comment now says to copy it to~/.gcode/.env.Validation
git diff --checkclean..env(grep over all.mdfiles).tests/test_setup.py,tests/test_errors.py) already cover~/.gcode/.env.