Skip to content

Commit 76407a9

Browse files
committed
docs: clarify CLI credential storage
1 parent 695917c commit 76407a9

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,19 @@ feedback --message "..." Send product/process feedback
130130
logout Clear saved local auth (does not revoke remote sessions)
131131
```
132132

133-
The CLI is agent-session-first. It stores a renewable Agent Analytics session locally after browser approval and uses that bearer auth for CLI API calls. Runtime-specific HTTP integrations should stay tied to the approved agent session, project setup, and project context rather than treating the CLI as a manual key setup path.
133+
The CLI is agent-session-first. It stores a renewable Agent Analytics session after browser approval and uses that bearer auth for CLI API calls. By default, macOS and Windows store the session secret in the OS keychain; Linux and headless environments use the CLI config file. Existing file-stored sessions migrate automatically to native storage on the next authenticated command when native storage is available. Runtime-specific HTTP integrations should stay tied to the approved agent session, project setup, and project context rather than treating the CLI as a manual key setup path.
134+
135+
Check local storage state without printing secrets:
136+
137+
```bash
138+
npx --yes @agent-analytics/cli@0.5.30 auth status
139+
```
140+
141+
Credential storage is automatic. Only use `AGENT_ANALYTICS_CREDENTIAL_STORE` for troubleshooting or managed runtimes:
142+
143+
- `file`: force config-file storage
144+
- `native`: require OS keychain and fail if unavailable
145+
- `auto`: default; usually not needed
134146

135147
When a free account hits a Pro-only analytics task, run an explicit upgrade handoff:
136148

@@ -283,6 +295,7 @@ Do not install the skill from this CLI repo. This package is the runtime CLI; th
283295
| `AGENT_ANALYTICS_CONFIG_DIR` | Directory containing CLI `config.json`; use a persistent path in managed runtimes |
284296
| `AGENT_ANALYTICS_URL` | Custom API URL (for self-hosted) |
285297
| `AGENT_ANALYTICS_DASHBOARD_URL` | Custom dashboard URL for local upgrade-link testing |
298+
| `AGENT_ANALYTICS_CREDENTIAL_STORE` | Optional credential storage override: `auto` (default), `native`, or `file` |
286299

287300
## Links
288301

0 commit comments

Comments
 (0)