docs(env): document Quickstart env file handling - #59
Open
sunshinexcode wants to merge 2 commits into
Open
Conversation
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
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.
Summary
Documents how Agora CLI produces Quickstart env files. The previous docs did not
explain where
.env.localcomes from, so users assumed it had to be downloadedfrom Console. This adds
docs/env-local.mddescribing the actual behavior: theCLI creates or updates the runtime-specific env file from the Quickstart's
example file plus the selected project's App ID and App Certificate.
Type of change
Public-contract impact
Test plan
Documentation-only change; no Go code touched.
go test ./...passes locally.make lintpasses locally.Verified the documented behavior manually against a CN test project:
agora init <name> --template nextjs --project <id>created.env.localwithNEXT_PUBLIC_AGORA_APP_IDandNEXT_AGORA_APP_CERTIFICATE, andagora quickstart env write . --project <id>recreated it after removal.Credential values were not printed or captured.
Documentation
README.mdupdated with a link to the new env file guide.CHANGELOG.mdupdated (no behavior change).docs/automation.mdupdated (no JSON, env var, or flag change).docs/error-codes.mdupdated (N/A).AGENTS.mdupdated (N/A).Security checklist
$HOME.unsafeimport.Additional notes
The original report stated that
.env.localcomes from a Console download orexport. Code review of
seedQuickstartEnvand the Quickstart template layoutsshowed no such flow exists today, so the doc describes CLI-side generation
instead. Docs also note that Python and Go Quickstarts target
server/.env.local, not a root-level.env.local.