@tryarcanist/cli 0.1.417 → 0.1.419
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 +4 -4
- package/dist/index.js +53 -52
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,14 +16,14 @@ Give your agent this prompt from a repository checkout:
|
|
|
16
16
|
|
|
17
17
|
> Install the latest @tryarcanist/cli and run `arcanist onboard --json`. Follow its next actions until this repository is ready and its first pull request review is verified. Open approval links for me when needed; run the terminal commands yourself. Keep me updated when something changes. Use `arcanist help onboard --json` for the full flow.
|
|
18
18
|
|
|
19
|
-
No Arcanist account or manually copied token is needed beforehand. New users approve sign-in in the browser; repository owners approve GitHub App installation when it is missing. Existing write-scoped CLI logins are reused. A browser-approved replacement supersedes a rejected or read-only project token for the same API; the project file stays unchanged. Explicit token overrides remain authoritative and must be replaced or unset if invalid. The agent checks the same command while approval is pending and continues automatically after approval. Approval links carry a challenge, never the CLI token; the verifier and approved token stay in private files under `~/.arcanist`.
|
|
19
|
+
No Arcanist account or manually copied token is needed beforehand. New users approve sign-in in the browser by typing the code the CLI shows; repository owners approve GitHub App installation when it is missing. Existing write-scoped CLI logins are reused. A browser-approved replacement supersedes a rejected or read-only project token for the same API; the project file stays unchanged. Explicit token overrides remain authoritative and must be replaced or unset if invalid. The agent checks the same command while approval is pending and continues automatically after approval. Approval links carry a challenge, never the CLI token; the verifier and approved token stay in private files under `~/.arcanist`.
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
22
|
arcanist onboard --json
|
|
23
23
|
arcanist onboard owner/repo --pr https://github.com/owner/repo/pull/123 --json
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Use `message` for plain-language progress. Share it when the state changes; keep polling and commands with the agent. Open approval links for the user when a browser is available, or show a clickable link. Approval stays with the user.
|
|
26
|
+
Use `message` for plain-language progress. Share it when the state changes; keep polling and commands with the agent. Open approval links for the user when a browser is available, or show a clickable link. Show `approvalCode` with a sign-in link: the user types it on the approval page. Approval stays with the user.
|
|
27
27
|
|
|
28
28
|
Follow `command` to resume and `repository.nextAction` for setup interventions. Poll `approval_required` and `setup_pending` every five seconds. `repository_ready` means setup finished but the first review is still unverified: pass an existing PR with `--pr`. `review_pending` resumes the same review. The CLI saves a request key before starting it, so retrying after a lost response recovers that review even after it finishes. Concurrent commands use the same saved request; if another command still holds the lock, the CLI asks you to retry shortly. Cancelled, rejected, or missing saved requests are cleared so the next invocation can retry. After new commits or an incomplete result, use `--pr <url> --restart-review` once to request verification again; resume with the returned command, which omits that flag. Only `complete` with `reviewVerified: true` proves a conclusive review of the returned `headSha`; findings do not make onboarding fail. `review_needs_attention` requires inspecting the incomplete result. Do not create a PR or change its code merely to finish onboarding.
|
|
29
29
|
|
|
@@ -36,7 +36,7 @@ For a setup question, pass its current ID to `arcanist environments answer owner
|
|
|
36
36
|
## Quick start
|
|
37
37
|
|
|
38
38
|
```bash
|
|
39
|
-
arcanist auth login # opens the browser; approve once
|
|
39
|
+
arcanist auth login # opens the browser; enter the code, approve once
|
|
40
40
|
printf "arc_..." | arcanist auth login --token-stdin # automation: a token from Settings > CLI
|
|
41
41
|
arcanist sessions list --json
|
|
42
42
|
```
|
|
@@ -49,7 +49,7 @@ arcanist sessions events "$SESSION_ID" --follow --json
|
|
|
49
49
|
|
|
50
50
|
## Authentication
|
|
51
51
|
|
|
52
|
-
In a terminal, `arcanist auth login` opens the Arcanist app in your browser.
|
|
52
|
+
In a terminal, `arcanist auth login` prints a code and opens the Arcanist app in your browser. Enter the code, approve once, and the CLI saves a new token. Pass `--scope write` for a write-scoped token (default `read`).
|
|
53
53
|
|
|
54
54
|
For automation, mint a token in **Settings > CLI** and pipe it to the CLI:
|
|
55
55
|
|