@runcanary/cli 0.1.13 → 0.1.15
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 +18 -7
- package/dist/canary.js +829 -144
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ canary verify # test the current local source using your setup
|
|
|
22
22
|
canary verify --base HEAD # compare only current edits against the local HEAD
|
|
23
23
|
canary skills # list what a coding agent can do with Canary (hosted index)
|
|
24
24
|
canary skill <name> # print the hosted instructions for one operation
|
|
25
|
-
canary gate on|off # the push check:
|
|
25
|
+
canary gate on|off # the push check: before an agent pushes or opens a PR from a chat Canary hasn't verified, it asks you first
|
|
26
26
|
canary hooks status # where the push check is registered (login adds it to Claude Code and Codex)
|
|
27
27
|
canary hooks uninstall # take it out of your agents' settings; run this before `npm uninstall`
|
|
28
28
|
```
|
|
@@ -31,16 +31,27 @@ After the CLI is gone, `npx -y @runcanary/cli hooks uninstall` removes the same
|
|
|
31
31
|
never touches anything but an agent's push or pull-request call, and lets that through whenever
|
|
32
32
|
Canary cannot answer.
|
|
33
33
|
|
|
34
|
+
On Codex the entry goes in `~/.codex/hooks.json`. Codex before 0.124 also runs no hooks until
|
|
35
|
+
`codex_hooks = true` is set. Canary asks your Codex whether it needs that line, and only when it
|
|
36
|
+
does (or no Codex CLI here can be asked) adds it to `~/.codex/config.toml`: one line marked
|
|
37
|
+
`# added by canary`, after keeping a copy of the file under `~/.canary/backups/`, and named when
|
|
38
|
+
it is added. `canary hooks uninstall` takes it out again. A `hooks` or `codex_hooks` setting of
|
|
39
|
+
your own is never changed.
|
|
40
|
+
|
|
34
41
|
Add `--json` to any command for machine-readable output.
|
|
35
42
|
|
|
36
43
|
Browser login shows an animated Canary while waiting for authorization, then a
|
|
37
44
|
contextual welcome after credentials are saved. It shows your account, active
|
|
38
|
-
CLI workspace, locally detected Git repository, actual agent-skill
|
|
39
|
-
and
|
|
40
|
-
workspace with the arrow keys and Enter, `c` to copy the instruction,
|
|
41
|
-
to finish login. The
|
|
42
|
-
|
|
43
|
-
|
|
45
|
+
CLI workspace, locally detected Git repository, actual agent-skill and plugin
|
|
46
|
+
status, and the next step: type `/canary` in your coding agent. Press `w` to
|
|
47
|
+
choose a workspace with the arrow keys and Enter, `c` to copy the instruction,
|
|
48
|
+
and Enter to finish login. The CLI saves the selected workspace and sends it with
|
|
49
|
+
every request.
|
|
50
|
+
|
|
51
|
+
Login also puts Canary's Claude Code plugin in `~/.canary/plugins` and names it
|
|
52
|
+
in Claude Code's user settings, so new chats can run Canary's checks on this
|
|
53
|
+
machine; each request keeps it current. Switch it off from Claude Code's
|
|
54
|
+
`/plugin` screen, or skip it with `--no-agent-skills`.
|
|
44
55
|
|
|
45
56
|
Login selects and shows the only workspace, or offers a workspace picker when
|
|
46
57
|
there are several. A previous valid selection is highlighted after checking
|