diff --git a/AGENTS.md b/AGENTS.md index 612771f..ff95754 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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. diff --git a/README.md b/README.md index f3fb3ec..389579c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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