nebula-ai 0.1.10 → 0.1.11
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 +19 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -140,6 +140,25 @@ The same surface is available from the command line:
|
|
|
140
140
|
|
|
141
141
|
Every command supports `--json` for machine-readable output, `-v/--verbose` for extra detail, `--no-color` to disable ANSI styling, and `--api-url <url>` to point at a non-default backend.
|
|
142
142
|
|
|
143
|
+
### Scripting contract
|
|
144
|
+
|
|
145
|
+
Exit codes: `0` success; `1` error (including a failed chat turn); `3` not
|
|
146
|
+
signed in or session unusable; `4` chat waiting for your decision; `5` a
|
|
147
|
+
message was sent or possibly accepted, but its outcome is unknown. For `5`,
|
|
148
|
+
check `nebula-ai channels messages <id>` before sending again.
|
|
149
|
+
|
|
150
|
+
With `--json`, errors are exactly one JSON line on stderr, without ANSI:
|
|
151
|
+
`{"error":{"code":"usage","message":"…"}}`. Codes are `error`, `usage`,
|
|
152
|
+
`auth_required`, and `outcome_unknown`. Results stay on stdout. Signed-out
|
|
153
|
+
`status --json` prints the full status document with `auth.logged_in:false`
|
|
154
|
+
and exits `3`; a network failure during validation does not imply sign-out.
|
|
155
|
+
|
|
156
|
+
`chat --json` returns `{thread_id, agent, status, final_message, events, pending}`.
|
|
157
|
+
When `status` is `waiting`, `pending` contains `{kind, title, summary}` (title
|
|
158
|
+
and summary may be null); otherwise `pending` is null. Failed, waiting, and
|
|
159
|
+
incomplete chat results still print on stdout before the corresponding exit.
|
|
160
|
+
|
|
161
|
+
|
|
143
162
|
## Privacy and telemetry
|
|
144
163
|
|
|
145
164
|
The CLI collects anonymized usage analytics (via PostHog) to help improve the product. You can opt out at any time:
|