@runcanary/cli 0.1.8 → 0.1.10
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 +51 -18
- package/dist/canary.js +97 -74
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,10 +14,12 @@ npx @runcanary/cli login
|
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
16
|
canary login # authenticate this device (opens your browser)
|
|
17
|
-
canary whoami # show the signed-in account
|
|
17
|
+
canary whoami # show the signed-in account and your runs this month
|
|
18
18
|
canary logout # revoke this device's token
|
|
19
19
|
canary workspace list # list / switch your workspaces
|
|
20
20
|
canary setup # verify this repo's .canary/ setup in a clean cloud sandbox
|
|
21
|
+
canary verify # test the current local source using your setup
|
|
22
|
+
canary verify --base HEAD # compare only current edits against the local HEAD
|
|
21
23
|
canary skills # list what a coding agent can do with Canary (hosted index)
|
|
22
24
|
canary skill <name> # print the hosted instructions for one operation
|
|
23
25
|
```
|
|
@@ -26,33 +28,40 @@ Add `--json` to any command for machine-readable output.
|
|
|
26
28
|
|
|
27
29
|
Browser login shows an animated Canary while waiting for authorization, then a
|
|
28
30
|
contextual welcome after credentials are saved. It shows your account, active
|
|
29
|
-
CLI workspace, locally detected
|
|
31
|
+
CLI workspace, locally detected Git repository, actual agent-skill status,
|
|
30
32
|
and an instruction to continue in your coding agent. Press `w` to choose a
|
|
31
33
|
workspace with the arrow keys and Enter, `c` to copy the instruction, and Enter
|
|
32
|
-
to finish login. The instruction is
|
|
33
|
-
|
|
34
|
+
to finish login. The instruction is "Verify my changes with Canary." when your
|
|
35
|
+
setup is ready, or "Onboard this repository to Canary." when setup is needed.
|
|
36
|
+
The CLI saves the selected workspace and sends it with setup and verify requests.
|
|
34
37
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
same account and API server.
|
|
38
|
-
|
|
38
|
+
Login selects and shows the only workspace, or offers a workspace picker when
|
|
39
|
+
there are several. A previous valid selection is highlighted after checking
|
|
40
|
+
membership for the same account and API server. Headless login preserves a valid
|
|
41
|
+
saved selection; otherwise pass `--workspace <id-or-name>` or follow the returned
|
|
42
|
+
`canary workspace use <id>` instruction. Repository names never switch workspaces.
|
|
39
43
|
|
|
40
44
|
Use `canary login --no-animation` or set `CANARY_NO_ANIMATION=1` for plain output. Redirected output,
|
|
41
45
|
CI, `TERM=dumb`, JSON, and token login also stay plain. `NO_COLOR` disables color.
|
|
46
|
+
An interactive browser login still asks for a missing workspace with a numbered
|
|
47
|
+
prompt when animation is off or the terminal is small. Enter your choice to save
|
|
48
|
+
it and finish login; no separate workspace command is needed.
|
|
42
49
|
|
|
43
|
-
The welcome, and the plain
|
|
44
|
-
repository stands for your account
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
50
|
+
The welcome, and the plain output when it is redirected, say where the local
|
|
51
|
+
repository stands for your account and selected workspace: your setup is ready,
|
|
52
|
+
not set up yet, or detected locally when that could not be checked. The lookup
|
|
53
|
+
has a three-second budget and never checks GitHub App installations. A checkout
|
|
54
|
+
whose `origin` is on GitHub is shown as `owner/name`; any other checkout is
|
|
55
|
+
shown by its directory name.
|
|
48
56
|
|
|
49
57
|
Browser login waits up to fifteen minutes for the authorization to come back — enough
|
|
50
|
-
for a first sign-up that creates a workspace and
|
|
58
|
+
for a first sign-up that creates a workspace and offers GitHub identity linking.
|
|
51
59
|
Plain output prints a line every minute while it waits. With `--json` the authorization
|
|
52
60
|
link is printed on stderr as its own JSON line whether or not a browser was opened, and
|
|
53
|
-
stdout stays one JSON document
|
|
54
|
-
repository
|
|
55
|
-
|
|
61
|
+
stdout stays one JSON document with authentication, workspace selection, and local
|
|
62
|
+
repository status. Login links your GitHub account to Canary; the link is required because
|
|
63
|
+
a pull request finds its author's setup through it. It does not install the GitHub App or
|
|
64
|
+
grant repository access. Setup and verify work without an origin remote or pushed commits.
|
|
56
65
|
|
|
57
66
|
## Onboard a repository
|
|
58
67
|
|
|
@@ -68,7 +77,31 @@ and say:
|
|
|
68
77
|
|
|
69
78
|
The agent discovers how your app installs and boots, writes the setup under
|
|
70
79
|
`.canary/`, and runs `canary setup` — which boots it from zero in a clean cloud
|
|
71
|
-
sandbox
|
|
80
|
+
sandbox from an uploaded local source snapshot. Green setup saves your setup and
|
|
81
|
+
explicit environment for this repository and workspace. Every setup belongs to one
|
|
82
|
+
user: teammates each run `canary setup` for their own, and yours never changes theirs.
|
|
83
|
+
|
|
84
|
+
The snapshot includes eligible unchanged source and the final contents of staged,
|
|
85
|
+
unstaged, deleted, binary, and untracked non-ignored files. `.git` and ignored paths
|
|
86
|
+
are excluded from both baseline and current trees. Source capture leaves the local
|
|
87
|
+
checkout and Git state unchanged; setup retains its explicit `.canary/` recipe and
|
|
88
|
+
environment write-back. Environment values still use `.canary/env.json` and the
|
|
89
|
+
existing explicit input flow, rather than scanning ignored files.
|
|
90
|
+
|
|
91
|
+
Ordinary `canary verify` reuses your approved setup and uploads fresh source.
|
|
92
|
+
Use `--base <local-ref>` on setup or verify to choose the comparison baseline. The
|
|
93
|
+
default uses a locally available comparison branch; without one, it reviews the
|
|
94
|
+
whole eligible project. No fetch is required. After fixing reported failures, use
|
|
95
|
+
`canary verify --failed <run-id>` once the previous run has finished.
|
|
96
|
+
|
|
97
|
+
The repository page shows your approved setup, environment key names, versions,
|
|
98
|
+
and CLI runs in the selected workspace. Other members cannot read your setup or
|
|
99
|
+
runs. Missing environment values can be supplied on that page.
|
|
100
|
+
|
|
101
|
+
A pull request you open runs on your setup automatically once the GitHub App is
|
|
102
|
+
installed for that repository; an admin installs it from Integrations. Teammates
|
|
103
|
+
get a comment on their PR asking them to run `canary setup` until they have their
|
|
104
|
+
own. A run keeps the setup it started with throughout execution.
|
|
72
105
|
|
|
73
106
|
In an interactive terminal, setup shows the animated Canary, repository, saved
|
|
74
107
|
CLI workspace, elapsed time, and the actual queued or running job state. When
|