@margay/ccl-core 1.5.1-alpha.5 → 1.5.1-alpha.7
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/QUICKSTART.md +29 -27
- package/README.md +28 -26
- package/dist/cli.js +126951 -134039
- package/dist/sdk/background.d.ts +14 -0
- package/dist/sdk/background.js +2 -1
- package/dist/sdk/index.d.ts +1 -1
- package/docs/background-runs.md +28 -0
- package/docs/cli-installation.md +23 -22
- package/docs/context-checkpoints-and-daemon.md +4 -0
- package/docs/gateway-vision-capabilities.md +38 -0
- package/docs/multi-gateway-auth-entry-usage.md +20 -0
- package/docs/releases/1.5.1-alpha.6.md +24 -0
- package/docs/releases/1.5.1-alpha.7.md +16 -0
- package/package.json +7 -4
- package/sdk/API.md +4 -0
package/QUICKSTART.md
CHANGED
|
@@ -7,13 +7,15 @@ from an npm package or source checkout. For the full feature map, see [README.md
|
|
|
7
7
|
## 1. Install
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npm install -g @margay/ccl-core
|
|
11
|
-
|
|
12
|
-
#
|
|
10
|
+
npm install -g @margay/ccl-core@1.5.1-alpha.6
|
|
11
|
+
ccl --version
|
|
12
|
+
# Expected: 1.5.1-alpha.6 (CCL); the latest tag is unchanged.
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Starting with `1.
|
|
16
|
-
|
|
15
|
+
Starting with `1.5.1-alpha.6`, this package provides only `ccl`. Upgrade older
|
|
16
|
+
dual-entry CCL packages before installing the independent `@margay/cli`, which
|
|
17
|
+
will provide `margay` on the 1.8 cleanhouse line. Existing CCL scripts should use
|
|
18
|
+
`ccl`; old documentation using the former alias refers to that same CCL command.
|
|
17
19
|
See [CLI installation and upgrades](docs/cli-installation.md) for local
|
|
18
20
|
versus global installation and migration of older launchers.
|
|
19
21
|
|
|
@@ -27,7 +29,7 @@ node dist/cli.js --version
|
|
|
27
29
|
|
|
28
30
|
## Local analytics on the upgraded workstation
|
|
29
31
|
|
|
30
|
-
Use `
|
|
32
|
+
Use `ccl analytics status` to inspect collection and `ccl analytics gate status` to inspect the analysis feature. Collection starts disabled and requires an authorized local website account to upload; installing this build does not change your login or connect production events. See [viewing events and controlling switches](docs/local-analytics-quickstart.md).
|
|
31
33
|
|
|
32
34
|
## 2. Choose Authentication
|
|
33
35
|
|
|
@@ -66,7 +68,7 @@ saved session. To sign out from a shell, use `node dist/cli.js logout`.
|
|
|
66
68
|
These existing TUI paths remain available:
|
|
67
69
|
|
|
68
70
|
```text
|
|
69
|
-
|
|
71
|
+
ccl
|
|
70
72
|
/gateway login <GATEWAY_URL> <GATEWAY_TOKEN>
|
|
71
73
|
/gateway register <GATEWAY_URL> <INVITE_CODE> [username] [email] [phone]
|
|
72
74
|
/gateway register --invite <INVITE_CODE>
|
|
@@ -87,7 +89,7 @@ status meanings, storage prerequisites, and troubleshooting.
|
|
|
87
89
|
### Interactive account login
|
|
88
90
|
|
|
89
91
|
```text
|
|
90
|
-
|
|
92
|
+
ccl
|
|
91
93
|
/login
|
|
92
94
|
```
|
|
93
95
|
|
|
@@ -99,7 +101,7 @@ may still be used by compatible channels, but are not created by this command.
|
|
|
99
101
|
|
|
100
102
|
```bash
|
|
101
103
|
export ANTHROPIC_API_KEY=<ANTHROPIC_API_KEY>
|
|
102
|
-
|
|
104
|
+
ccl --model "<available-model-id>"
|
|
103
105
|
```
|
|
104
106
|
|
|
105
107
|
Do not paste real keys into docs, shell history examples, bug reports, or shared
|
|
@@ -110,23 +112,23 @@ screenshots.
|
|
|
110
112
|
Interactive:
|
|
111
113
|
|
|
112
114
|
```bash
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
115
|
+
ccl
|
|
116
|
+
ccl --model deepseek-v4-pro
|
|
117
|
+
ccl --cwd /path/to/project
|
|
116
118
|
```
|
|
117
119
|
|
|
118
120
|
One-shot:
|
|
119
121
|
|
|
120
122
|
```bash
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
123
|
+
ccl -p "explain this error" < error.log
|
|
124
|
+
ccl -p "summarize the current repository" --max-turns 20
|
|
125
|
+
ccl -p "return JSON" --output-format json
|
|
124
126
|
```
|
|
125
127
|
|
|
126
128
|
Streaming automation:
|
|
127
129
|
|
|
128
130
|
```bash
|
|
129
|
-
|
|
131
|
+
ccl -p "run a compact audit" --output-format stream-json --verbose
|
|
130
132
|
```
|
|
131
133
|
|
|
132
134
|
## 4. Useful First Slash Commands
|
|
@@ -155,13 +157,13 @@ Run slash commands inside the interactive TUI.
|
|
|
155
157
|
## 5. Common CLI Options
|
|
156
158
|
|
|
157
159
|
```bash
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
160
|
+
ccl --help
|
|
161
|
+
ccl -p "task" --model "<available-model-id>" --effort high
|
|
162
|
+
ccl -p "task" --allowedTools "Bash(git:*) Edit"
|
|
163
|
+
ccl -p "task" --disallowedTools "Bash(rm:*)"
|
|
164
|
+
ccl --bare -p "minimal startup task"
|
|
165
|
+
ccl --resume <SESSION_ID>
|
|
166
|
+
ccl --continue
|
|
165
167
|
```
|
|
166
168
|
|
|
167
169
|
Important safety options:
|
|
@@ -176,10 +178,10 @@ Important safety options:
|
|
|
176
178
|
## 6. Workflows
|
|
177
179
|
|
|
178
180
|
```bash
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
181
|
+
ccl workflow validate <name-or-path>
|
|
182
|
+
ccl workflow run <name-or-path> --json
|
|
183
|
+
ccl workflow run <name-or-path> --dry-run
|
|
184
|
+
ccl workflow generate "produce a release audit workflow"
|
|
183
185
|
```
|
|
184
186
|
|
|
185
187
|
Inside CCL:
|
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ The analytics commands support opt-in event upload, funnel/retention/path/experi
|
|
|
18
18
|
|
|
19
19
|
## Requirements
|
|
20
20
|
|
|
21
|
-
- Node.js
|
|
21
|
+
- Node.js 22.19.0 or newer.
|
|
22
22
|
- At least one authentication path:
|
|
23
23
|
- Margay website account or gateway token for gateway-routed models.
|
|
24
24
|
- Existing external-service OAuth credentials for compatible subscription-backed channels; `/login` signs in to Margay.
|
|
@@ -27,14 +27,16 @@ The analytics commands support opt-in event upload, funnel/retention/path/experi
|
|
|
27
27
|
## Install
|
|
28
28
|
|
|
29
29
|
```bash
|
|
30
|
-
npm install -g @margay/ccl-core
|
|
31
|
-
|
|
32
|
-
#
|
|
30
|
+
npm install -g @margay/ccl-core@1.5.1-alpha.6
|
|
31
|
+
ccl --version
|
|
32
|
+
# Expected: 1.5.1-alpha.6 (CCL); the latest tag is unchanged.
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Starting with `1.
|
|
36
|
-
|
|
37
|
-
|
|
35
|
+
Starting with `1.5.1-alpha.6`, this package provides only `ccl`. Upgrade older
|
|
36
|
+
dual-entry CCL packages before installing the independent `@margay/cli`, which
|
|
37
|
+
will provide `margay` on the 1.8 cleanhouse line. Existing CCL scripts should use
|
|
38
|
+
`ccl`; old documentation using the former alias refers to that same CCL command.
|
|
39
|
+
For installation scope, command ownership and old
|
|
38
40
|
launcher migration, see [CLI installation and upgrades](docs/cli-installation.md).
|
|
39
41
|
|
|
40
42
|
From a source checkout:
|
|
@@ -48,18 +50,18 @@ node dist/cli.js --version
|
|
|
48
50
|
## Start A Session
|
|
49
51
|
|
|
50
52
|
```bash
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
53
|
+
ccl
|
|
54
|
+
ccl "review the current git diff"
|
|
55
|
+
ccl --model deepseek-v4-pro
|
|
56
|
+
ccl --cwd /path/to/project
|
|
55
57
|
```
|
|
56
58
|
|
|
57
59
|
Use `--print` for scripts and pipelines:
|
|
58
60
|
|
|
59
61
|
```bash
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
62
|
+
ccl -p "explain this stack trace" < error.log
|
|
63
|
+
ccl -p "return JSON only" --output-format json
|
|
64
|
+
ccl -p "stream events" --output-format stream-json --verbose
|
|
63
65
|
```
|
|
64
66
|
|
|
65
67
|
## Authentication
|
|
@@ -69,7 +71,7 @@ configuration.
|
|
|
69
71
|
|
|
70
72
|
| Channel | Use For | Setup |
|
|
71
73
|
|---|---|---|
|
|
72
|
-
| Margay website account | Shared Margay identity and gateway-routed models | `
|
|
74
|
+
| Margay website account | Shared Margay identity and gateway-routed models | `ccl login`, or `/login` / `/gateway login` in the TUI |
|
|
73
75
|
| Manual Margay gateway | Existing gateway tokens or invite codes | `/gateway login <url> <token>` or `/gateway register <url> <invite>` |
|
|
74
76
|
| Existing external-service OAuth credentials | Compatible external-service channels | Legacy credential compatibility; `/login` and first-launch onboarding use Margay website authorization |
|
|
75
77
|
| Messages API key | Direct API use | Set `ANTHROPIC_API_KEY=<key>` or pass `--api-key <key>` |
|
|
@@ -126,7 +128,7 @@ recovery, see [docs/gateway-quickstart.md](./docs/gateway-quickstart.md).
|
|
|
126
128
|
|
|
127
129
|
## CLI Surface
|
|
128
130
|
|
|
129
|
-
`
|
|
131
|
+
`ccl --help` is the exact runtime source for command-line behavior. The current
|
|
130
132
|
top-level commands are:
|
|
131
133
|
|
|
132
134
|
| Command | Purpose |
|
|
@@ -242,8 +244,8 @@ Useful controls:
|
|
|
242
244
|
For one-off runs:
|
|
243
245
|
|
|
244
246
|
```bash
|
|
245
|
-
|
|
246
|
-
|
|
247
|
+
ccl -p "summarize this diff" --model "<available-model-id>"
|
|
248
|
+
ccl -p "generate a migration plan" --model "<available-model-id>" --effort high
|
|
247
249
|
```
|
|
248
250
|
|
|
249
251
|
Capability pools use explicit `cost-first ranking` and `quality-first ranking`
|
|
@@ -266,11 +268,11 @@ The `workflow` command and `/workflows` slash command run multi-step task
|
|
|
266
268
|
automation.
|
|
267
269
|
|
|
268
270
|
```bash
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
271
|
+
ccl workflow run <name-or-path>
|
|
272
|
+
ccl workflow run <name-or-path> --params '{"out":"report.md"}' --json
|
|
273
|
+
ccl workflow run <name-or-path> --dry-run
|
|
274
|
+
ccl workflow validate <name-or-path>
|
|
275
|
+
ccl workflow generate "create a regression audit workflow"
|
|
274
276
|
```
|
|
275
277
|
|
|
276
278
|
Inside the TUI:
|
|
@@ -369,12 +371,12 @@ Config locations:
|
|
|
369
371
|
|
|
370
372
|
| Symptom | Check |
|
|
371
373
|
|---|---|
|
|
372
|
-
| `
|
|
374
|
+
| `ccl` cannot authenticate | Run `/doctor`, `/gateway doctor`, or `/login` |
|
|
373
375
|
| Gateway status differs between shells | Check exported `CCL_GATEWAY_URL` and `CCL_GATEWAY_KEY` versus `~/.ccl/gateway.json` |
|
|
374
376
|
| A model name fails | Run `/model` or query the gateway's model list |
|
|
375
377
|
| `--print` runs too long | Set `--max-turns`, `--max-budget-usd`, or `CCL_PRINT_MAX_TURNS` |
|
|
376
378
|
| Tool permission prompts block automation | Use `--allowedTools`, `--disallowedTools`, `--permission-mode`, or the SDK `canUseTool` callback |
|
|
377
|
-
| MCP servers behave unexpectedly | Run `
|
|
379
|
+
| MCP servers behave unexpectedly | Run `ccl doctor` from a trusted directory and inspect `--mcp-config` inputs |
|
|
378
380
|
|
|
379
381
|
## Source Of Truth
|
|
380
382
|
|
|
@@ -392,6 +394,6 @@ The current authoritative documentation set is:
|
|
|
392
394
|
|
|
393
395
|
### Project instructions
|
|
394
396
|
|
|
395
|
-
|
|
397
|
+
CCL automatically loads `CCL.md`, `.ccl/CCL.md`, `CCL.local.md`, and `.ccl/rules/**/*.md`, respecting the existing scope, exclusions, and conditional rules. Project and local instructions are included by default.
|
|
396
398
|
|
|
397
399
|
`CLAUDE.md`, `CLAUDE.local.md`, `.ccl/CLAUDE.md`, and `.claude/rules/` are not discovered automatically, even when no CCL file exists. To share a document deliberately, import it from `CCL.md` with `@CLAUDE.md`; normal import permissions still apply. Explicit file reads and existing conversation history remain available.
|