Skip to content

docs: clarify required vs optional API keys in .env setup (#3844) #4112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xingzihai wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify required vs optional API keys in .env setup (#3844) #4112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ pre-commit install
# 4. Copy the environment template
cp .env.example .env
# Edit .env with your API keys as needed
#
# Required API keys (for basic usage with Claude Code):
# - ANTHROPIC_API_KEY: Get from https://platform.claude.com/account/keys
#
# Optional API keys (feature-specific):
# - Azure credentials (AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET,
# AZURE_SUBSCRIPTION_ID): Only needed for remote execution on Azure VMs
# - OPENAI_API_KEY / AZURE_OPENAI_*: For OpenAI/Azure OpenAI integrations
#
# Note: GitHub Copilot CLI uses your existing GitHub Copilot subscription
# (no additional API key needed). Microsoft Amplifier uses an interactive
# configuration wizard on first startup.
#
# All other variables in .env.example have sensible defaults and are optional.
```

### Running Tests
Expand Down
Loading