@tryarcanist/cli 0.1.99 → 0.1.100
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 +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,7 +34,7 @@ arcanist auth login
|
|
|
34
34
|
|
|
35
35
|
Token config is stored at `~/.arcanist/config.json`. Multiple active tokens per user are supported; revoke tokens independently when a device or workflow no longer needs access.
|
|
36
36
|
|
|
37
|
-
Use a read-scoped token for inspection and debugging
|
|
37
|
+
Use a read-scoped token for inspection and debugging; use a write-scoped token only to create sessions, send prompts, or stop runs.
|
|
38
38
|
|
|
39
39
|
You can also pipe the token via stdin:
|
|
40
40
|
|
|
@@ -55,7 +55,7 @@ export ARCANIST_TOKEN=arc_...
|
|
|
55
55
|
export ARCANIST_API_URL=https://app.tryarcanist.com
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
`--token` and `--api-url` are available for one-off invocations. Prefer `ARCANIST_TOKEN` over `--token` for persistent use
|
|
58
|
+
`--token` and `--api-url` are available for one-off invocations. Prefer `ARCANIST_TOKEN` over `--token` for persistent use; CLI flags can appear in shell history and process lists.
|
|
59
59
|
|
|
60
60
|
Non-local API URLs must use HTTPS and must not embed credentials.
|
|
61
61
|
|
|
@@ -128,17 +128,17 @@ arcanist sessions create your-org/your-repo "verify the deployed change" --cold
|
|
|
128
128
|
arcanist sessions create your-org/your-repo "retry-safe create" --idempotency-key 1f0e6f1a-...
|
|
129
129
|
```
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
`--backend` picks the agent runtime backend: `codex` (default) or `claude_code`. `--model` must be valid for the chosen backend — codex runs OpenAI models (`gpt-5.5` default, `gpt-5.4`), `claude_code` runs Anthropic models (`claude-opus-4-8` default, `claude-sonnet-4-6`) — and the CLI rejects a mismatch before any network call. `claude_code` sessions require an Anthropic API key configured in Settings.
|
|
132
132
|
|
|
133
|
-
|
|
133
|
+
`--wait` blocks until the created prompt finishes and exits non-zero if the prompt finishes with `status: failed`, making it suitable for cron or other schedulers that alert on command failure. `--poll-interval <ms>` tunes the completion check frequency.
|
|
134
134
|
|
|
135
|
-
|
|
135
|
+
Repeatable `--uploaded-file <path>` flags attach local UTF-8 text files to the prompt. Uploaded file names come from the local basename; directory components are not sent.
|
|
136
136
|
|
|
137
|
-
|
|
137
|
+
`--cold` forces a fresh sandbox and skips the warm pool — useful for verifying freshly deployed code when a pre-warmed sandbox may predate the deploy.
|
|
138
138
|
|
|
139
|
-
|
|
139
|
+
`--idempotency-key <uuid>` is for manually retrying a create request that may have reached the server. The CLI derives separate session and prompt idempotency keys from the provided value.
|
|
140
140
|
|
|
141
|
-
JSON mode returns `{sessionId, sessionUrl?, repoUrl, model?, agentRuntimeBackend?, reasoningEffort?, promptId?}`. `sessionUrl` is emitted only when the server returns it; `agentRuntimeBackend`
|
|
141
|
+
JSON mode returns `{sessionId, sessionUrl?, repoUrl, model?, agentRuntimeBackend?, reasoningEffort?, promptId?}`. `sessionUrl` is emitted only when the server returns it; `agentRuntimeBackend` only when `--backend` is passed.
|
|
142
142
|
|
|
143
143
|
### `arcanist sessions send <session-id> [prompt]`
|
|
144
144
|
|
|
@@ -155,7 +155,7 @@ JSON mode returns `{sessionId, promptId?}`.
|
|
|
155
155
|
|
|
156
156
|
### `arcanist sessions stop <session-id>`
|
|
157
157
|
|
|
158
|
-
Stops the active run for a session.
|
|
158
|
+
Stops the active run for a session. Idempotent: if no sandbox is active, the server returns `already_stopped`.
|
|
159
159
|
|
|
160
160
|
```bash
|
|
161
161
|
arcanist sessions stop abc123
|
|
@@ -190,7 +190,7 @@ arcanist sessions search "mcp debugging" --repo your-org/your-repo --json
|
|
|
190
190
|
arcanist sessions search "repo access" --status idle --scope business --limit 20 --cursor <cursor>
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
|
|
193
|
+
Uses the same metadata-only index and filters as `sessions list`: `--status`, `--scope`, `--repo`, `--limit`, and `--cursor`.
|
|
194
194
|
|
|
195
195
|
### `arcanist sessions events <session-id>`
|
|
196
196
|
|