@tryarcanist/cli 0.1.383 → 0.1.384
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 +46 -57
- package/dist/index.js +168 -26876
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -157,6 +157,27 @@ arcanist environments retry owner/repo --wait --json
|
|
|
157
157
|
arcanist environments retry owner/repo --wait --poll-interval 5000 --json
|
|
158
158
|
```
|
|
159
159
|
|
|
160
|
+
### `arcanist environments export`
|
|
161
|
+
|
|
162
|
+
Write an environment's configuration as one JSON file: name, description, provisioning kind and app runtime config, helper files, cache settings (setup, maintenance and smoke scripts, dependencies, CPU and memory) and trusted domains. Secrets, the saved browser login and the review doc are not exported. Read-scoped tokens can export. Pass an environment id or `owner/repo` outside a checkout.
|
|
163
|
+
|
|
164
|
+
```bash
|
|
165
|
+
arcanist environments export owner/repo -o environment.json
|
|
166
|
+
ARCANIST_API_URL=https://app.tryarcanist.com arcanist environments export owner/repo > prod.json
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### `arcanist environments import`
|
|
170
|
+
|
|
171
|
+
Apply an exported file to the same repository's environment on the current deployment, so one deployment can mirror another (for example QA from production). A write-scoped token is required. The target's primary repository must match the file. `--dry-run` lists the fields that differ without changing anything. When a build input changes, the server schedules a rebuild.
|
|
172
|
+
|
|
173
|
+
`--create` creates the environment from the file when the deployment has no team environment for the file's primary repository, and the server schedules its first build. It applies only without an `[environment]` argument. The Arcanist GitHub App must be installed for the repository there. A created environment has no secrets, browser login or review doc.
|
|
174
|
+
|
|
175
|
+
```bash
|
|
176
|
+
ARCANIST_API_URL=https://staging.example.com arcanist environments import prod.json --dry-run
|
|
177
|
+
ARCANIST_API_URL=https://staging.example.com arcanist environments import prod.json --json
|
|
178
|
+
ARCANIST_API_URL=https://staging.example.com arcanist environments import local.json --create
|
|
179
|
+
```
|
|
180
|
+
|
|
160
181
|
### `arcanist environments login`
|
|
161
182
|
|
|
162
183
|
Log into your app once in a throwaway local browser and save that login on the environment so Arcanist sessions start signed in. Alias: `arcanist env login`. A write-scoped token is required. Pass an environment id or `owner/repo` outside a checkout; the environment must have an app runtime configured.
|
|
@@ -236,62 +257,6 @@ arcanist codex status --json
|
|
|
236
257
|
JSON mode returns `{eligible, credential: {isSet, lastValidationStatus?, lastValidationReasonCode?}}`; `eligible` is always
|
|
237
258
|
`true` and remains for compatibility with older clients.
|
|
238
259
|
|
|
239
|
-
### `arcanist codex logout`
|
|
240
|
-
|
|
241
|
-
Removes the saved Codex subscription `auth.json`. OpenAI sessions fall back to the platform key.
|
|
242
|
-
|
|
243
|
-
```bash
|
|
244
|
-
arcanist codex logout
|
|
245
|
-
```
|
|
246
|
-
|
|
247
|
-
### `arcanist settings …`
|
|
248
|
-
|
|
249
|
-
Reads and changes every customer-facing setting the web app exposes. A read-scope token reads; a write-scope token changes.
|
|
250
|
-
Workspace-wide changes (team defaults, exclusions, members, invite, secrets, integrations) also need the admin role.
|
|
251
|
-
`approvals show` and `approvals set` both need a write-scope token and the admin role. `repo-reviews set`,
|
|
252
|
-
`review-instructions set`, and `learned-doc clear` need write permission on the repository on GitHub.
|
|
253
|
-
Every subcommand supports `--json`, which prints the API payload. Secret values are never printed.
|
|
254
|
-
|
|
255
|
-
```bash
|
|
256
|
-
arcanist settings show # your review display preferences
|
|
257
|
-
arcanist settings set --inline-nits on
|
|
258
|
-
arcanist settings team-reviews show
|
|
259
|
-
arcanist settings team-reviews set --auto-review on --drafts off
|
|
260
|
-
arcanist settings repo-reviews list
|
|
261
|
-
arcanist settings repo-reviews set acme/widgets --check blocking
|
|
262
|
-
arcanist settings my-reviews set acme/widgets --auto-review inherit
|
|
263
|
-
arcanist settings branch-exclusions add acme/widgets 'release/*'
|
|
264
|
-
arcanist settings bot-exclusions add dependabot[bot]
|
|
265
|
-
arcanist settings approvals show acme/widgets
|
|
266
|
-
arcanist settings approvals set --policy-file policy.json
|
|
267
|
-
arcanist settings review-instructions set acme/widgets --file REVIEW.md
|
|
268
|
-
arcanist settings learned-doc clear acme/widgets
|
|
269
|
-
arcanist settings members set-role 42 admin
|
|
270
|
-
arcanist settings invite rotate
|
|
271
|
-
arcanist settings secrets set acme/widgets NPM_TOKEN --value-file token.txt --sensitive on
|
|
272
|
-
arcanist settings secrets import acme/widgets --file secrets.env
|
|
273
|
-
arcanist settings integrations list
|
|
274
|
-
arcanist settings setup answer acme/widgets <question-id> "use pnpm"
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
Run `arcanist settings <group> --help` for the flags of each group.
|
|
278
|
-
|
|
279
|
-
### `arcanist resource-pools …` and `arcanist environments resources …`
|
|
280
|
-
|
|
281
|
-
Manages shared resource pools (pooled credentials that sandboxes lease) and which environments draw from them.
|
|
282
|
-
|
|
283
|
-
```bash
|
|
284
|
-
arcanist resource-pools create accounts
|
|
285
|
-
arcanist resource-pools list
|
|
286
|
-
arcanist resource-pools slots add accounts --name primary --credentials-file creds.env
|
|
287
|
-
arcanist resource-pools slots set accounts <slot-id> --name primary --credentials-file creds.env
|
|
288
|
-
arcanist resource-pools slots rm accounts <slot-id>
|
|
289
|
-
arcanist resource-pools rm accounts
|
|
290
|
-
arcanist environments resources list <environment-id>
|
|
291
|
-
arcanist environments resources attach <environment-id> --name db --pool accounts
|
|
292
|
-
arcanist environments resources detach <environment-id> --name db
|
|
293
|
-
```
|
|
294
|
-
|
|
295
260
|
### `arcanist sessions get <session-id>`
|
|
296
261
|
|
|
297
262
|
```bash
|
|
@@ -416,7 +381,7 @@ The upload limit is 3 MB. Each delivered review counts toward your plan's review
|
|
|
416
381
|
|
|
417
382
|
Held-back files are committed, so they ship with your branch; the CLI lists them as `Committed but not uploaded for review (pass --include <path> to upload)`.
|
|
418
383
|
|
|
419
|
-
Output is the headline (`Arcanist review: Hold off on merging.` when a finding blocks merge, else `Arcanist review: Ready to merge.`), the summary, then each finding as `file:line - title` followed by its full text. A blocking finding's title ends with `(blocks merge)`; a non-blocking finding has no tag. A finding with an agent prompt shows it under `Agent prompt:`, ready to paste into a coding agent in this checkout. Then
|
|
384
|
+
Output is the headline (`Arcanist review: Hold off on merging.` when a finding blocks merge, else `Arcanist review: Ready to merge.`), the summary, then each finding as `file:line - title` followed by its full text. A blocking finding's title ends with `(blocks merge)`; a non-blocking finding has no tag. A finding with an agent prompt shows it under `Agent prompt:`, ready to paste into a coding agent in this checkout. Then `✅ Ruled out (N)` lists what the review tried to break and why it held. JSON mode returns `{status, requestId, sessionId, verdict, summary, findings, alsoChecked}`, where each finding is `{file, line, blocksMerge, title, body}`, plus `agentPrompt` when it has one; each Ruled out item is `{title, conclusion}`. `alsoChecked` is left out when empty. `environmentDegradedReason` is added when the review ran without a prepared environment.
|
|
420
385
|
|
|
421
386
|
Exit codes: `0` when no finding blocks merge, `1` when a finding blocks merge or the review could not start, `4` when another review of yours is still running, `5` when the review is still running (`--no-wait`), `10` when the review failed, `130` when interrupted (Ctrl-C or SIGTERM).
|
|
422
387
|
|
|
@@ -437,3 +402,27 @@ For cron, prefer `ARCANIST_TOKEN` or a logged-in `~/.arcanist/config.json` over
|
|
|
437
402
|
- **401 on a previously working token**: the token may have expired or been revoked in Settings. Regenerate and log in again.
|
|
438
403
|
- **`You do not have access to this repository on GitHub`**: the token's user lacks repo access; fix the GitHub connection or use an accessible repo.
|
|
439
404
|
- **`command not found`**: run `npm install -g @tryarcanist/cli`.
|
|
405
|
+
|
|
406
|
+
### Read existing review diagnostics
|
|
407
|
+
|
|
408
|
+
```bash
|
|
409
|
+
arcanist reviews get <pr-request-id> --json
|
|
410
|
+
arcanist reviews stages <session-id> --json
|
|
411
|
+
arcanist reviews stages <session-id> judge --json
|
|
412
|
+
arcanist sessions view <session-id> --json
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
These commands read existing data. They start no review or model run and do not poll.
|
|
416
|
+
Successful reads exit 0, including active reviews and results with blocking findings.
|
|
417
|
+
API errors retain the normal exit codes. Quiet text mode suppresses output. JSON mode preserves the complete response.
|
|
418
|
+
|
|
419
|
+
`reviews get` accepts a **PR request ID** and returns `{review, requestStatus}`.
|
|
420
|
+
The lifecycle snapshot preserves `unavailableRequestIds` and retry/recovery state.
|
|
421
|
+
For a **local request ID**, use `arcanist review --request <id> --no-wait --json` with its existing review exit codes.
|
|
422
|
+
|
|
423
|
+
Stage reads require Arcanist membership. The index lists stage names, byte sizes, and upload timestamps.
|
|
424
|
+
A selected record includes full structured `input`, `output`, and `threads`. The CLI fetches no other records.
|
|
425
|
+
|
|
426
|
+
`sessions view` returns the enriched session envelope for the token workspace.
|
|
427
|
+
Its prompts contain the first page only (`promptLimit=1`). Use `sessions transcript` for full activity and `sessions artifacts` for files.
|
|
428
|
+
`sessions get` keeps its raw session response.
|