Skip to content

Document URL env vars as staging-only for Amendable developers #2

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

Merged
fangpenlin merged 1 commit into from
Aug 23, 2026
Merged

Document URL env vars as staging-only for Amendable developers #2

Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ Rust CLI (`amendable`) for the Amendable API.
- Git password is the access token. There is no SSH.
- Command name is `amendable`. Package name is `amendable-cli`.

Staging is a config override, not a different command set:
Staging is a config override for Amendable developers, not a different command set:

- `amendable --staging` / `amendable login --staging`
- `AMENDABLE_API_URL=https://stage.api.amendable.io`
- `AMENDABLE_APP_URL=https://stage.amendable.io`

Do not document those URL env vars in customer docs (`../amendable-docs`). Hardcode production hosts there.

Config file: `~/.config/amendable/config.toml` (mode `0600`).

Authoritative API behavior lives in `../amendable-web`. Customer docs live in `../amendable-docs`. If the CLI disagrees with the API, fix the CLI. If the docs disagree with the CLI, fix the docs.
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ amendable repo create hello
amendable repo clone hello
```

Defaults are production (`https://api.amendable.io`). For staging:
Defaults are production (`https://api.amendable.io`). Change hosts only when developing Amendable against the staging server:

```bash
amendable login --staging
Expand Down Expand Up @@ -40,7 +40,7 @@ token = "..."
username = "yourname"
```

Override with `AMENDABLE_TOKEN`, `AMENDABLE_API_URL`, `AMENDABLE_APP_URL`, `AMENDABLE_USERNAME`, or `AMENDABLE_CONFIG`.
Override with `AMENDABLE_TOKEN`, `AMENDABLE_USERNAME`, or `AMENDABLE_CONFIG`.

## Tests

Expand Down
Loading