@astralbeam/cli 0.22.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,17 +1,13 @@
1
1
  # @astralbeam/cli
2
2
 
3
- Manage an AstralBeam organization from the terminal: its Tenants and TenantUsers, short-lived chat and organization tokens, and test chats with its agents. Every command prints JSON with `--json`, so coding agents such as Claude Code can drive it too.
4
-
5
- ```sh
6
- npx @astralbeam/cli --help
7
- ```
3
+ Manage an AstralBeam organization's Tenants and TenantUsers, mint short-lived tokens, and test its agents from the terminal. Use `--json` for scripts and coding agents.
8
4
 
9
5
  ## Install
10
6
 
11
7
  Run it with npm on Node 22.12 or later, with no install step:
12
8
 
13
9
  ```sh
14
- npx @astralbeam/cli tenants list
10
+ npx @astralbeam/cli --help
15
11
  ```
16
12
 
17
13
  Or install it globally as `astralbeam`:
@@ -52,7 +48,7 @@ Every command then uses the nearest bound directory at or above where it runs, a
52
48
  ▸ Acme (acme) · org 01990a5d-… · bound at ~/work/acme
53
49
  ```
54
50
 
55
- A directory with no bound ancestor fails with exit code 1 instead of guessing an organization. For CI and agents, set `ASTRALBEAM_API_KEY`, which overrides any binding, and `ASTRALBEAM_API_URL` when self-hosting. API URLs must use `https://`, except for `localhost`.
51
+ A directory with no bound ancestor fails with exit code 1 instead of guessing an organization. For CI and agents, set `ASTRALBEAM_API_KEY`, which overrides any binding, and `ASTRALBEAM_API_URL` when self-hosting. API URLs require HTTPS, except for HTTP on loopback hosts (`localhost`, IPv4 `127.0.0.0/8`, or `[::1]`).
56
52
 
57
53
  Check the binding commands will use, or list them all:
58
54
 
@@ -84,9 +80,9 @@ astralbeam chat --tenant customer-42 --user user-7 "What can you do?"
84
80
 
85
81
  ## Output and exit codes
86
82
 
87
- Human-readable tables and records go to stdout. With `--json`, stdout carries the API's JSON and stderr holds one JSON object: `{"context": {...}}` naming the organization on success, or `{"error": {...}, "context": {...}}` with the API's problem details on failure. Commands exit with `0` on success, `1` when the API or runtime fails, and `2` for invalid usage.
83
+ Human-readable tables and records go to stdout. With `--json`, records and pages stay in API format, and `--all` merges fetched pages. Non-interactive operations write one stderr object: `{"context": {...}}` on success or `{"error": {...}, "context": {...}}` on failure. API failures retain their problem details, while runtime and usage errors provide `error.detail`. Help and version output remain plain text. Commands exit with `0` on success, `1` when the API or runtime fails, and `2` for invalid usage.
88
84
 
89
- When a command fails unexpectedly, rerun it with `--debug` to log each HTTP request's method, URL, status, and duration, plus the failure's stack trace, to stderr. It never logs headers, so keys and tokens stay out of the output, but it adds lines that break the single JSON object `--json` writes to stderr.
85
+ For unexpected failures, use `--debug` to log HTTP methods, URLs, status, duration, and stack traces to stderr, without headers. It adds lines beyond the JSON object. After a failed write, check whether it succeeded before retrying.
90
86
 
91
87
  ## Coding agents
92
88