docks-kit 0.21.0 → 0.22.0
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/AGENTS.md +11 -9
- package/README.md +21 -20
- package/cli/docs/command-guards.md +13 -10
- package/cli/docs/flags.md +26 -6
- package/cli/docs/install.md +1 -1
- package/cli/docs/omp-models.md +96 -44
- package/cli/docs/platforms.md +6 -4
- package/cli/src/checklistPrompt.ts +464 -0
- package/cli/src/commands/docs.ts +1 -1
- package/cli/src/commands/harnesses.ts +20 -11
- package/cli/src/commands/omp.ts +93 -22
- package/cli/src/commands/scratch.ts +1 -1
- package/cli/src/engine-native/DESIGN.md +4 -3
- package/cli/src/engine-native/ompOverlay.ts +96 -26
- package/cli/src/engine-native/os/targets.ts +3 -11
- package/cli/src/engine-native/os/windows.ts +1 -1
- package/cli/src/engine-native/tidyLock.ts +30 -5
- package/cli/src/engine.ts +1 -1
- package/cli/src/generated/sotPayload.ts +6 -6
- package/cli/src/main.ts +3 -1
- package/cli/src/terminalCells.ts +191 -0
- package/docks-kit +3 -4
- package/docks-kit.ps1 +3 -4
- package/package.json +2 -2
package/AGENTS.md
CHANGED
|
@@ -21,7 +21,7 @@ Tool-specific instructions live alongside this file:
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
docks-kit runtime and standalone binary support covers Linux x64/arm64, macOS
|
|
24
|
-
|
|
24
|
+
arm64, and Windows x64. Hosts outside this matrix fail before either
|
|
25
25
|
launcher can fall back to Bun source.
|
|
26
26
|
|
|
27
27
|
## Repository layout (cross-cutting)
|
|
@@ -29,11 +29,12 @@ launcher can fall back to Bun source.
|
|
|
29
29
|
| Path | Purpose |
|
|
30
30
|
|------|---------|
|
|
31
31
|
| `docks-kit` / `docks-kit.ps1` | POSIX and Windows CLI launchers. On supported hosts, each runs the matching binary in `cli/dist/` only when its `--version` matches `package.json`. Otherwise it runs Bun-from-source and auto-installs Bun plus `node_modules`, and the mismatch warning names the rebuild remedy. A launcher never deletes a binary: on a host without Bun it is the only remaining recovery path. Hosts outside the support matrix fail before source fallback. The standalone platform release binary provides no-Bun recovery. |
|
|
32
|
-
| `cli/build-binaries.sh` | Compiles the
|
|
32
|
+
| `cli/build-binaries.sh` | Compiles the four release binaries (`docks-kit-linux-x64`, `docks-kit-linux-arm64`, `docks-kit-darwin-arm64`, `docks-kit-windows-x64.exe`). It checksums the four known artifact names rather than globbing `docks-kit-*`, so a packed `docks-kit-<version>.tgz` is never attested as a release binary. It stamps `cli/dist/VERSION` only when the directory holds one version, and on the next build discards every artifact that stamp attributes to a different version, because a launcher refuses to run one and keeping it makes `SHA256SUMS` span two versions. An artifact with no stamp has unknown provenance and may be a hand-built or downloaded recovery binary, so the script keeps it and warns; `--prune` discards those too. Nothing here removes an artifact the stamp vouches for. |
|
|
33
33
|
| `cli/src/engine-native/` | EngineNative implementation for `sync`, `model`, and `toolchain`; idempotent, flag-gated for destructive reconciliation |
|
|
34
34
|
| `cli/src/engine-native/ompSync.ts` | omp sync orchestration and summary |
|
|
35
|
-
| `cli/src/commands/omp.ts` | `docks-kit omp` session launcher: renders the free-model run overlay and
|
|
36
|
-
| `cli/src/
|
|
35
|
+
| `cli/src/commands/omp.ts` | `docks-kit omp` session launcher: rejects model-selecting forwarded flags, checks the free catalog of each candidate profile, renders the free-model run overlay, and starts `omp launch` |
|
|
36
|
+
| `cli/src/checklistPrompt.ts` / `cli/src/terminalCells.ts` | Shared terminal checklist prompt on Effect's `Prompt.Custom`: items, a Save row, key hints, an ASCII fallback, and NO_COLOR; `docks-kit harnesses` uses it. `terminalCells.ts` measures text in terminal cells and rows from the pinned Unicode 18.0.0 East Asian Width table; derive the table again from a newer `EastAsianWidth.txt` the same way its header says |
|
|
37
|
+
| `cli/src/engine-native/ompOverlay.ts` | Free-model overlay render, omp argv and child environment, plus catalog parse and thinking-ceiling helpers |
|
|
37
38
|
| `cli/src/engine-native/scratch.ts` / `cli/src/commands/scratch.ts` | `docks-kit scratch new\|remove`: private agent temporary directories under `~/.cache/docks-kit/scratch/`; removal accepts only a real path strictly inside the scratch root, the system temporary directory, or `/var/tmp` |
|
|
38
39
|
| `cli/src/engine-native/tidy.ts` / `tidyReport.ts` / `cli/src/commands/tidy.ts` | `docks-kit tidy [--apply] [--repo <path>] [--report]`: plan and apply the safe leftover sweep (merged idle worktrees and their containers, orphaned processes in agent directories, idle scratch); Docker calls run only against a verified local endpoint (`unix:///…` or `npipe:////./pipe/…`); the report is read-only |
|
|
39
40
|
| `cli/src/engine-native/ompKitPlugin.ts` | Materializes the `SoT/.omp/plugin/` payload to `~/.docks-kit/omp-plugin` with the kit version; `ompPlugins.ts syncPlugins` links it |
|
|
@@ -48,8 +49,8 @@ launcher can fall back to Bun source.
|
|
|
48
49
|
| `SoT/toolchain.json` | Toolchain floors manifest (verified pins consumed by EngineNative; optional `upstream` source read by `docks-kit toolchain outdated`) |
|
|
49
50
|
| `SoT/.claude/bin/` | Dependency-free Bun runtime programs for Claude's statusline, SessionStart, and Notification |
|
|
50
51
|
| `SoT/.omp/` | Kit-owned omp SoT: `AGENTS.md`, `config.yml`, `models.yml`, `mcp.json`, and `intercom.json` |
|
|
51
|
-
| `install.sh` / `install.ps1` | POSIX and Windows global installers |
|
|
52
|
-
| `.github/workflows/release-cli.yml` | `cli-v*` release:
|
|
52
|
+
| `install.sh` / `install.ps1` | POSIX and Windows global installers. Each installer stops on a host outside the support matrix before it downloads anything. |
|
|
53
|
+
| `.github/workflows/release-cli.yml` | `cli-v*` release: four binaries (Linux x64 and arm64, macOS arm64, Windows x64), plus `SHA256SUMS` and npm publish |
|
|
53
54
|
| `README.md` | Front door |
|
|
54
55
|
| `package.json` / `bun.lock` | npm package: `bin` = `cli/src/main.ts`; bundles `cli/` with the generated in-memory SoT payload |
|
|
55
56
|
| `SoT/.agents/skills.txt` | Universal-skill manifest, intentionally empty by default. Adding an [agentskills.io](https://agentskills.io/specification) slug opts it into EngineNative's shared `~/.agents/skills/` bootstrap and Claude symlink. |
|
|
@@ -93,8 +94,9 @@ omp SoT notes:
|
|
|
93
94
|
- `task.agentIdleTtlMs` is `120000`, so omp parks an idle subagent after 2 minutes instead of 7. `browser.idleCloseSec` is `600`.
|
|
94
95
|
- By owner decision (0.21.0), resources on the workstation are always development, so `docks-kit tidy` sweeps them without a question. The omp prompt rules, the `workspace-hygiene` skill, `/cleanup`, and the extension reminders limit the cleanup of a remote resource (reached through SSH or a provider CLI such as `wrangler`, `vercel`, `kubectl`, or a remote Docker host) to targets named local, development, dev, test, homolog, homologation, staging, or preview, the plan-lifecycle non-production definition. A production cleanup needs an `ask` immediately before it, must be rare, and a `yolo` invocation does not answer that ask. Prompt rules cannot force an agent to ask, so this rule has no `bash.patterns` guard.
|
|
95
96
|
- The omp CLI is upstream-owned. It updates through `omp update`, or through the external manager that owns the install, such as Tern or Nix. `omp update` refuses to run on an install that an external manager owns. Sync never installs or upgrades the CLI.
|
|
96
|
-
- `docks-kit omp [--model <selector>|--pick] [args...]` starts one interactive omp session. The overlay sets the 16 roles in `ompOverlay.ts ROLE_ORDER`, `judge` and `memory` included, to one free model
|
|
97
|
-
- The
|
|
97
|
+
- `docks-kit omp [--model <selector>|--pick] [args...]` starts one interactive omp session. The overlay sets the 16 roles in `ompOverlay.ts ROLE_ORDER`, `judge` and `memory` included, to one free model, empties the 13 retry chains in `FALLBACK_ORDER`, and empties the chains keyed by the free model (bare, `off`, and every `THINKING_LADDER` level). Every other deployed chain stays as deployed. In particular, `modelRoles.web` and `retry.fallbackChains.web` keep the deployed web-search provider order. Thus a web search that falls through the `web/*` providers can reach the paid `openai-codex/gpt-6-luna` entry. It renders the overlay to `~/.cache/docks-kit/omp-free-<model>-<digest>.yml` (mode 0600). `ompOverlay.ts overlayFileName` gives each distinct model-and-level combination its own file, and the digest covers the selector and both levels. omp can re-read the overlay during a live session, so a second launcher with another model or level must not rewrite it. Deployed `~/.omp/agent/` files stay untouched, so the next plain `omp` run uses the paid configuration again.
|
|
98
|
+
- The launcher enforces the free model before omp starts. `omp.ts rejectedForwardedFlag` rejects a forwarded `--config`, `--model`, `--smol`, `--slow`, `--plan`, `--models`, `--provider`, `--prewalk-into`, or `--plan-yolo-into`, in both forms and also after a `--`, with exit 2 and a message that names the recoveries. `ompOverlay.ts buildOmpArgs` starts omp as `omp launch --config <overlay> --model <selector>[:<level>] [args...]`, so every forwarded word is message text, no omp subcommand runs through the launcher, and `--continue` or `--resume` keeps the free model. `ompOverlay.ts ompChildEnvironment` sets `PI_SMOL_MODEL`, `PI_SLOW_MODEL`, and `PI_PLAN_MODEL` to the free role values, and appends the overlay to `PI_CONFIG_FILES` so an `omp` that the bash tool of the session starts loads it too. The launcher prints one warning for each exported model variable that it replaces. In-session selection (`Alt+M`, `Alt+P`, `/switch`, `/model`, `/modelpreset`, `/resume`, a seance subagent), the `web` role, the model-kind roles `image`, `speech`, and `dictation`, and extensions and hooks stay outside the launcher. An `Alt+M` assignment of `default` writes `modelRoles.default` to the deployed `~/.omp/agent/config.yml`. `cli/docs/omp-models.md` lists these paths.
|
|
99
|
+
- The session model persists per machine in `~/.docks-kit/kit.db` (table `omp_session`), next to the harness selection. The default is `opencode-zen/muse-spark-1.3-contributor-free` at `xhigh`. Every launch, a plain launch included, runs `omp models --json` for the profile of the environment and `omp --profile <name> models --json` for each forwarded `--profile` value, and checks the remembered or default model against each live free catalog. When that model is not free in every one of these catalogs, the launcher stops with an error and does not start omp. `--model` and `--pick` resolve against the catalog of the last forwarded profile. `ompOverlay.ts ladderCeiling, advisorLevelFor` derive both levels from the ladder of the chosen model for the `--model` path, and `ompOverlay.ts planEffortChoice` drives the `--pick` wizard, which asks whether every role shares one level and otherwise takes one level for the main roles and one for the advisor from that model's own ladder. Levels never come from a fixed list: free ladders are not uniform, three free models publish no `medium`, and two publish no ladder, which the overlay renders as bare selectors. The picker lists only catalog models at zero input and output cost with `pricingStatus` free or unknown.
|
|
98
100
|
- `docks-kit omp --fast` toggles `tier.openai` in the deployed `~/.omp/agent/config.yml` between `priority` (omp's `/fast on` tier for OpenAI and OpenAI-Codex models) and `none`, prints the change, and exits. `ompFastMode.ts toggleOpenAiFast` edits only that key. `SoT/.omp/config.yml` does not declare `tier.openai`, so the additive merge keeps the toggled value across sync. There is no Ultrafast flag: omp ignores `ultrafast` for a Codex model whose catalog `serviceTiers` omits it, and the current GPT models omit it.
|
|
99
101
|
|
|
100
102
|
For per-tool SoT layouts (`SoT/.claude/`, `SoT/.codex/`, `SoT/.omp/`), see the matching SoT directory.
|
|
@@ -131,7 +133,7 @@ For per-tool SoT layouts (`SoT/.claude/`, `SoT/.codex/`, `SoT/.omp/`), see the m
|
|
|
131
133
|
- **One exemption: the kit's own package.** `install.sh` and `install.ps1` end with `bun add -g docks-kit@latest`, because a global installer that pinned itself would install a fixed old kit forever, and pinning it to `package.json` would request an unpublished version between the release-prep commit and the npm publish. The exemption covers `docks-kit` alone. Both installers still pin the Bun installer they download to the manifest's verified version. `cli/test/unit/hostTargets.test.ts` asserts that pin in all four launcher and installer scripts, and `cli/test/unit/install.test.ts` proves `install.sh` passes it to the Bun installer.
|
|
132
134
|
## Testing
|
|
133
135
|
|
|
134
|
-
Run `bun run check` before and after each change: oxlint, `oxfmt --check`, `
|
|
136
|
+
Run `bun run check` before and after each change: oxlint, `oxfmt --check`, `bun check`, unit tests, and both golden suites. Scripts: `lint`, `format:check`, `typecheck`, `test:unit`, `test:integration` (goldens), `test`, `format`; CI runs `check` on push and pull request with Bun 1.4.4. Prove-red modes must exit non-zero after detecting planted mismatches. The golden writer emits two-space JSON that `oxfmt` re-serializes, so run `bun run format` after `--update-goldens` or `format:check` fails. Also verify user-facing changes via `./docks-kit sync --dry-run`, per-tool sanity (`/doctor`, `/plugin`, etc.), `bun run test:runtime:posix`, and `diff <(jq -S . <SoT>) <(jq -S . <deployed>)` recipes from the per-tool file.
|
|
135
137
|
|
|
136
138
|
Use direct acceptance and focused regressions while iterating, then run the full unit/golden gate once at the pre-commit or release boundary. Reuse still-matching evidence; a later relevant edit invalidates only the affected rung and final gate, not every prior check.
|
|
137
139
|
|
package/README.md
CHANGED
|
@@ -19,8 +19,8 @@ cd ~/projects/public
|
|
|
19
19
|
./docks-kit status # doctor view: drift, toolchain, plugins, skills
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
POSIX hosts use the `./docks-kit` launcher on x64 and arm64
|
|
23
|
-
`.\docks-kit.ps1` on x64
|
|
22
|
+
POSIX hosts use the `./docks-kit` launcher on Linux x64 and arm64 and on macOS
|
|
23
|
+
arm64. Windows uses `.\docks-kit.ps1` on x64. Each launcher prefers the matching compiled
|
|
24
24
|
binary in `cli/dist/` only when its version matches the checkout. Otherwise it
|
|
25
25
|
runs from source via Bun and auto-installs Bun plus dependencies when needed.
|
|
26
26
|
Hosts outside this matrix fail immediately and never fall back to Bun source.
|
|
@@ -112,21 +112,23 @@ and a later flag-less sync reverts them. Full reference: `docks-kit docs flags`
|
|
|
112
112
|
working legacy hook/statusline setup and reports that migration is deferred.
|
|
113
113
|
- **Command guards** — omp, Claude Code, and Codex share one fail-closed
|
|
114
114
|
policy for destructive shell commands; to remove, agents use the trash
|
|
115
|
-
(`gio trash -- <path>`, or `trash <path>` on macOS)
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
115
|
+
(`gio trash -- <path>`, or `trash <path>` on macOS); omp agents remove a
|
|
116
|
+
temporary file or directory with `docks-kit scratch remove`. `rm` of the
|
|
117
|
+
home directory or `/` and `HOME` reassignment are denied. omp also denies
|
|
118
|
+
every recursive `rm`, `find -delete`, `find -exec rm`, and `xargs rm`, and
|
|
119
|
+
runs any other `rm` without a prompt. In omp, `git clean`,
|
|
120
|
+
`git reset --hard`, and any `git push` that could force ask; Claude Code and
|
|
121
|
+
Codex also ask before `find -delete`, a recursive `rm`, and every `git rm`.
|
|
122
|
+
An omp subagent cannot answer an ask, so omp rejects it; a Codex ask can go
|
|
123
|
+
to its `auto_review` reviewer. Details, per-tool differences, and gaps:
|
|
123
124
|
`docks-kit docs command-guards`.
|
|
124
|
-
- **Agent cleanup (omp)** — `docks-kit scratch` creates
|
|
125
|
-
|
|
126
|
-
merged idle worktrees, their containers,
|
|
127
|
-
scratch directories; `--report` lists other
|
|
128
|
-
omp plugin `docks-kit-omp` exposes these as
|
|
129
|
-
what it created, and runs the sweep at most
|
|
125
|
+
- **Agent cleanup (omp)** — `docks-kit scratch` creates agent temporary
|
|
126
|
+
directories and removes agent temporary files and directories with checked
|
|
127
|
+
paths, and `docks-kit tidy` removes merged idle worktrees, their containers,
|
|
128
|
+
orphaned processes, and idle scratch directories; `--report` lists other
|
|
129
|
+
disk and memory use. The kit omp plugin `docks-kit-omp` exposes these as
|
|
130
|
+
tools, reminds the agent of what it created, and runs the sweep at most
|
|
131
|
+
once per 12 hours.
|
|
130
132
|
|
|
131
133
|
## Repository map
|
|
132
134
|
|
|
@@ -152,17 +154,16 @@ and a later flag-less sync reverts them. Full reference: `docks-kit docs flags`
|
|
|
152
154
|
|----------|--------------|------------------|-------------|
|
|
153
155
|
| Linux | x64 | ✅ | ✅ native |
|
|
154
156
|
| Linux | arm64 | ✅ | ✅ native |
|
|
155
|
-
| macOS | x64 | ✅ | ✅ native |
|
|
156
157
|
| macOS | arm64 | ✅ | ✅ native |
|
|
157
158
|
| Windows | x64 | ✅ | ✅ native |
|
|
158
|
-
| Windows | arm64 | ✅ | ✅ native |
|
|
159
159
|
|
|
160
160
|
Details: `docks-kit docs platforms`.
|
|
161
161
|
|
|
162
162
|
## Releases
|
|
163
163
|
|
|
164
|
-
Tagging `cli-v*` builds
|
|
165
|
-
|
|
164
|
+
Tagging `cli-v*` builds four standalone binaries: `docks-kit-linux-x64`,
|
|
165
|
+
`docks-kit-linux-arm64`, `docks-kit-darwin-arm64`, and
|
|
166
|
+
`docks-kit-windows-x64.exe`. The workflow attaches them plus `SHA256SUMS` to the GitHub
|
|
166
167
|
release. npm publishes the exact package tarball through trusted publishing
|
|
167
168
|
with OIDC provenance.
|
|
168
169
|
Published binaries, checksums, and release notes are available on
|
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
The kit ships one destructive-command policy to omp, Claude Code, and Codex.
|
|
4
4
|
The short rule for agents: **to remove, use the trash**. Run
|
|
5
|
-
`gio trash -- <path>` on Linux or `trash <path>` on macOS.
|
|
6
|
-
|
|
5
|
+
`gio trash -- <path>` on Linux or `trash <path>` on macOS. In omp, remove a
|
|
6
|
+
temporary file or directory with `docks-kit scratch remove <path>` instead.
|
|
7
|
+
To remove a path from the git index, run `git rm -- <path>`.
|
|
7
8
|
|
|
8
9
|
The policy follows one principle: **fail closed**. A command is allowed only
|
|
9
10
|
in a canonical form that is safe by construction. Every other form that could
|
|
@@ -81,14 +82,16 @@ it shares the `--f` prefix.
|
|
|
81
82
|
|
|
82
83
|
## How an agent removes files
|
|
83
84
|
|
|
84
|
-
1.
|
|
85
|
-
or `
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
a
|
|
85
|
+
1. In omp, remove a temporary file or directory with the `scratch_remove`
|
|
86
|
+
tool or `docks-kit scratch remove <path>`. The command removes only a path
|
|
87
|
+
inside the scratch root, the system temporary directory, or `/var/tmp`.
|
|
88
|
+
`gio trash` does not trash on a system internal mount, such as a `tmpfs`
|
|
89
|
+
`/tmp`.
|
|
90
|
+
2. Move every other file or directory to the trash with `gio trash -- <path>`
|
|
91
|
+
on Linux or `trash <path>` on macOS. The `--` ends option parsing, so `gio`
|
|
92
|
+
reads every later argument as a path, and a path such as `--empty` cannot
|
|
93
|
+
empty the trash. In Claude Code and Codex, leave a temporary file in
|
|
94
|
+
`/tmp`; the system clears it.
|
|
92
95
|
3. To remove a path from the git index, run `git rm -- <path>`. To remove a
|
|
93
96
|
worktree, run `git worktree remove -- <path>`. In omp, when git refuses
|
|
94
97
|
because the worktree has changes, the agent may pass `--force` once, after
|
package/cli/docs/flags.md
CHANGED
|
@@ -18,7 +18,9 @@ Positional targets are `claude`, `codex`, `agents`, and `omp`. A flag-less
|
|
|
18
18
|
`codex`, and `agents`, and never selects `omp`. Choose the stored selection
|
|
19
19
|
with `docks-kit harnesses`. With no stored selection, its picker pre-ticks all
|
|
20
20
|
four harnesses, `omp` included; a flag-less `sync` does not change until the
|
|
21
|
-
picker saves a selection.
|
|
21
|
+
picker saves a selection. In the picker, Enter or Space ticks or unticks the
|
|
22
|
+
harness under the cursor, Enter on the Save row stores the selection, and
|
|
23
|
+
Escape leaves it unchanged.
|
|
22
24
|
|
|
23
25
|
## Global flags
|
|
24
26
|
|
|
@@ -62,9 +64,26 @@ ignored with a warning; Claude modifiers never touch Codex config and vice versa
|
|
|
62
64
|
| `--pick` | Interactive picker over free catalog models; records the choice the same way |
|
|
63
65
|
| `--fast` | Toggle `tier.openai` between `priority` and `none` in the deployed `~/.omp/agent/config.yml`, print the change, and exit; the same tier omp's `/fast on` selects for OpenAI and Codex models |
|
|
64
66
|
|
|
65
|
-
|
|
66
|
-
`
|
|
67
|
-
the
|
|
67
|
+
The launcher starts omp as
|
|
68
|
+
`omp launch --config <overlay> --model <selector>[:<level>]`, followed by the
|
|
69
|
+
remaining arguments in the same order. `docks-kit omp -p "..."` runs one
|
|
70
|
+
prompt. `docks-kit omp --continue` resumes the previous session on the free
|
|
71
|
+
model. A bare `docks-kit omp` opens an interactive session. `launch` makes omp
|
|
72
|
+
read every forwarded word as message text, so no omp subcommand runs through
|
|
73
|
+
the launcher; run `omp` directly for a subcommand.
|
|
74
|
+
|
|
75
|
+
The launcher rejects a forwarded `--config`, `--model`, `--smol`, `--slow`,
|
|
76
|
+
`--plan`, `--models`, `--provider`, `--prewalk-into`, or `--plan-yolo-into`,
|
|
77
|
+
in the `--flag value` and the `--flag=value` form and also after a `--`. It
|
|
78
|
+
exits with code 2 before omp starts. The error names the flag and the
|
|
79
|
+
recoveries: `--model <selector>` before the other arguments or `--pick` for a
|
|
80
|
+
free model, `omp` directly for a paid model, and `PI_CONFIG_FILES` for another
|
|
81
|
+
config file. The launcher sets `PI_SMOL_MODEL`, `PI_SLOW_MODEL`, and
|
|
82
|
+
`PI_PLAN_MODEL` to the free role values, warns once for each exported value
|
|
83
|
+
that it replaces, and appends the overlay to `PI_CONFIG_FILES`. See
|
|
84
|
+
[omp-models.md](omp-models.md#free-session-launcher-docks-kit-omp) for the
|
|
85
|
+
full policy and the paths that stay outside the launcher.
|
|
86
|
+
|
|
68
87
|
The launcher changes no deployed file and never invokes `sync`, except for
|
|
69
88
|
`--fast`, which changes only `tier.openai` and launches nothing. `--fast` over
|
|
70
89
|
`ultrafast` selects `priority`.
|
|
@@ -75,8 +94,9 @@ never reach omp:
|
|
|
75
94
|
- `--model`, `--pick`, `--fast`
|
|
76
95
|
- `--help`, `--version`, `--log-level`, `--wizard`, `--completions`
|
|
77
96
|
|
|
78
|
-
The same names
|
|
79
|
-
`docks-kit omp -- --help`
|
|
97
|
+
The same names, except `--model`, stay reachable on omp behind an explicit
|
|
98
|
+
delimiter. `docks-kit omp -- --help` prints the help of `omp launch`. A
|
|
99
|
+
forwarded `--model` stops the launcher with exit 2, also behind `--`.
|
|
80
100
|
|
|
81
101
|
## `scratch` and `tidy`
|
|
82
102
|
|
package/cli/docs/install.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Installing docks-kit
|
|
2
2
|
|
|
3
|
-
Supported hosts are Linux x64/arm64, macOS
|
|
3
|
+
Supported hosts are Linux x64/arm64, macOS arm64, and Windows x64.
|
|
4
4
|
Hosts outside this matrix fail before a launcher can fall back to Bun source.
|
|
5
5
|
|
|
6
6
|
## 1. Repo checkout (development / current users)
|
package/cli/docs/omp-models.md
CHANGED
|
@@ -423,13 +423,17 @@ overlay sets the 16 chat-model roles in `ompOverlay.ts ROLE_ORDER` to that
|
|
|
423
423
|
model and empties the 13 retry fallback chains in `ompOverlay.ts
|
|
424
424
|
FALLBACK_ORDER`. These roles include `memory` and `judge`. The SoT does
|
|
425
425
|
not set them, but omp otherwise uses its built-in priority chain for them,
|
|
426
|
-
and that chain can name a paid model. The overlay
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
`
|
|
431
|
-
|
|
432
|
-
|
|
426
|
+
and that chain can name a paid model. The overlay also empties the retry
|
|
427
|
+
chains keyed by the free model: the bare selector, `<selector>:off`, and
|
|
428
|
+
`<selector>:<level>` for every level in `ompOverlay.ts THINKING_LADDER`. omp
|
|
429
|
+
uses a chain keyed by the model before a role chain, so a project or
|
|
430
|
+
`PI_CONFIG_FILES` chain for the free model could otherwise reach a paid model.
|
|
431
|
+
The overlay does not set the `web` role or its retry chain. The deployed
|
|
432
|
+
web-search provider order therefore applies, and that order includes the paid
|
|
433
|
+
`openai-codex/gpt-6-luna` entry. omp merges the overlay key by key. Each other
|
|
434
|
+
deployed retry chain, such as a `plan`, `slow`, or `designer` chain, therefore
|
|
435
|
+
stays in the merged config. A retry of the free model does not reach such a
|
|
436
|
+
chain, because omp uses the empty chain keyed by the free model first.
|
|
433
437
|
The overlay also sets `defaultThinkingLevel` and `task.maxEffort`, except for
|
|
434
438
|
a model that publishes no thinking ladder, where both keys are omitted and the
|
|
435
439
|
deployed values apply.
|
|
@@ -447,31 +451,70 @@ apart. A session launch never reads or writes `~/.omp/agent/config.yml` or
|
|
|
447
451
|
never touches the SoT. The next plain `omp` run uses the paid configuration
|
|
448
452
|
again.
|
|
449
453
|
|
|
450
|
-
|
|
451
|
-
omp
|
|
452
|
-
|
|
454
|
+
The launcher starts omp as
|
|
455
|
+
`omp launch --config <overlay> --model <selector>[:<level>] [args...]`, where
|
|
456
|
+
`[args...]` are the arguments after the launcher flags, in the same order.
|
|
457
|
+
`docks-kit omp -p "..."` runs one prompt. `docks-kit omp --continue` resumes
|
|
458
|
+
the previous session. A bare `docks-kit omp` opens an interactive session.
|
|
459
|
+
|
|
460
|
+
`launch` makes omp read every forwarded word as message text. So `docks-kit
|
|
461
|
+
omp commit` sends `commit` to the free model as a prompt, and no omp
|
|
462
|
+
subcommand runs through the launcher. To run an omp subcommand such as
|
|
463
|
+
`commit`, `bench`, or `search`, run `omp` directly. The explicit `--model`
|
|
464
|
+
outranks the model that omp restores from a stored session. So `--continue`,
|
|
465
|
+
`--resume`, and `autoResume` keep the free model and its level.
|
|
466
|
+
|
|
467
|
+
### Model selection that the launcher controls
|
|
453
468
|
|
|
454
469
|
The overlay ranks above the deployed global and project configuration, and
|
|
455
|
-
below runtime overrides and later overlay files.
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
-
|
|
459
|
-
|
|
460
|
-
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
470
|
+
below runtime overrides and later overlay files. The launcher handles each
|
|
471
|
+
known input that can select a model above the overlay:
|
|
472
|
+
|
|
473
|
+
- Forwarded model flags. The launcher rejects `--config`, `--model`,
|
|
474
|
+
`--smol`, `--slow`, `--plan`, `--models`, `--provider`, `--prewalk-into`,
|
|
475
|
+
and `--plan-yolo-into`, in the `--flag value` and the `--flag=value` form.
|
|
476
|
+
It exits with code 2 and starts no omp process. It checks every forwarded
|
|
477
|
+
argument, also after a `--`, because omp can read that `--` as the value of
|
|
478
|
+
a flag such as `--api-key` and then read the next flag. The error names the
|
|
479
|
+
flag and the recoveries. For a free model, put `--model <selector>` before
|
|
480
|
+
the other arguments or use `--pick`. For a paid model, run `omp` directly.
|
|
481
|
+
For another config file, list it in `PI_CONFIG_FILES`.
|
|
482
|
+
- A restored session model. The explicit `--model` keeps the free model.
|
|
483
|
+
- An omp subcommand. `launch` makes it message text.
|
|
464
484
|
- The model environment variables `PI_SMOL_MODEL`, `PI_SLOW_MODEL`, and
|
|
465
|
-
`PI_PLAN_MODEL`.
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
-
|
|
470
|
-
`
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
485
|
+
`PI_PLAN_MODEL`. The launcher sets each one to the overlay value of its
|
|
486
|
+
role in the omp environment, and prints one warning for each exported value
|
|
487
|
+
that it replaces. omp fills an unset or empty variable from its `.env`
|
|
488
|
+
files, so the launcher sets the variables instead of removing them.
|
|
489
|
+
- `PI_CONFIG_FILES`. The launcher appends the overlay path to the exported
|
|
490
|
+
entries, so an `omp` that the bash tool of the session starts loads the
|
|
491
|
+
overlay too. omp loads these files below `--config` overlays, so an exported
|
|
492
|
+
entry still applies below the overlay. A `PI_CONFIG_FILES` value in an omp
|
|
493
|
+
`.env` file does not apply in a launcher session, because the launcher
|
|
494
|
+
always sets the variable.
|
|
495
|
+
- The omp profile. The catalog check below covers every profile that the
|
|
496
|
+
launch can select.
|
|
497
|
+
|
|
498
|
+
### Model selection outside the launcher
|
|
499
|
+
|
|
500
|
+
These paths act after omp starts or outside the chat roles. The launcher does
|
|
501
|
+
not control them:
|
|
502
|
+
|
|
503
|
+
- In-session selection. `Alt+M` (model hub), `Alt+P` (session-only picker),
|
|
504
|
+
`/switch <selector>`, `/model`, and `/modelpreset` can select any catalog
|
|
505
|
+
model. `/resume` and a session switch restore the model of the target
|
|
506
|
+
session. A seance subagent runs on the models of its source session. An
|
|
507
|
+
`Alt+M` assignment of the `default` role writes `modelRoles.default` to the
|
|
508
|
+
deployed `~/.omp/agent/config.yml`, so later plain `omp` runs use it too.
|
|
509
|
+
- The `web` role and its retry chain. By owner decision they keep the
|
|
510
|
+
deployed web-search provider order, which can reach the paid
|
|
511
|
+
`openai-codex/gpt-6-luna` entry.
|
|
512
|
+
- The model-kind roles `image`, `speech`, and `dictation`. A chat model
|
|
513
|
+
cannot serve them, so the overlay does not set them.
|
|
514
|
+
- Extensions and hooks. `-e`, `--hook`, and `--plugin-dir` run arbitrary
|
|
515
|
+
code, and that code can select any model.
|
|
516
|
+
|
|
517
|
+
These lists name the known paths. They are not a closed set.
|
|
475
518
|
|
|
476
519
|
The default model is `opencode-zen/muse-spark-1.3-contributor-free` ("Muse
|
|
477
520
|
Spark 1.3 Free", 1,048,576-token context) at `xhigh`. `xhigh` is the ceiling
|
|
@@ -500,11 +543,11 @@ zero input and output cost with `pricingStatus` `free` or `unknown` (26
|
|
|
500
543
|
entries on 2026-09-11). A zero-cost row with another status, such as
|
|
501
544
|
`variable` or `included`, is billed outside the token price, so the picker
|
|
502
545
|
leaves it out. The resulting overlay sets the 16 `ROLE_ORDER` roles to the
|
|
503
|
-
chosen free model and empties the 13 `FALLBACK_ORDER` chains
|
|
504
|
-
its chain, and each other deployed chain
|
|
505
|
-
|
|
506
|
-
advertise a free model that the account cannot call; omp reports
|
|
507
|
-
provider error unchanged.
|
|
546
|
+
chosen free model and empties the 13 `FALLBACK_ORDER` chains and the chains
|
|
547
|
+
keyed by that model. The `web` role, its chain, and each other deployed chain
|
|
548
|
+
keep the deployed values. The
|
|
549
|
+
catalog can advertise a free model that the account cannot call; omp reports
|
|
550
|
+
that provider error unchanged.
|
|
508
551
|
|
|
509
552
|
After the model, the wizard asks about thinking levels. `ompOverlay.ts
|
|
510
553
|
planEffortChoice` decides which questions apply, because omp accepts a
|
|
@@ -527,16 +570,25 @@ A session whose advisor differs from the other roles reports both on the
|
|
|
527
570
|
launch line.
|
|
528
571
|
|
|
529
572
|
An omp login is required. The kit owns no login flow. Every launch reads the
|
|
530
|
-
live free catalog
|
|
531
|
-
default model, against
|
|
532
|
-
launcher stops before omp starts. The model can be
|
|
533
|
-
provider that is not logged in. Without this
|
|
534
|
-
default model of the first logged-in
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
573
|
+
live free catalog of each candidate profile. A plain launch checks the
|
|
574
|
+
remembered model, or the default model, against those catalogs. When the
|
|
575
|
+
model is not there, the launcher stops before omp starts. The model can be
|
|
576
|
+
renamed, repriced, or on a provider that is not logged in. Without this
|
|
577
|
+
check, omp silently starts the default model of the first logged-in
|
|
578
|
+
provider, which can be paid.
|
|
579
|
+
|
|
580
|
+
Each omp profile has its own login and `models.yml`, so a selector can be
|
|
581
|
+
free in one profile and missing or paid in another. The candidate profiles
|
|
582
|
+
are the profile of the environment (`OMP_PROFILE`, `PI_PROFILE`, or the
|
|
583
|
+
default) and each forwarded `--profile <name>` or `--profile=<name>` value.
|
|
584
|
+
The launcher reads every forwarded argument, also after a `--`, because omp
|
|
585
|
+
can read that `--` as a flag value and then select a later profile. It runs
|
|
586
|
+
`omp models --json` for the profile of the environment and
|
|
587
|
+
`omp --profile <name> models --json` for each forwarded name. The session
|
|
588
|
+
model must be free in every one of these catalogs. `--model` and `--pick`
|
|
589
|
+
choose from the catalog of the last forwarded profile, or of the profile of
|
|
590
|
+
the environment when the arguments name none. A `--profile` without a name
|
|
591
|
+
stops the launcher before omp starts.
|
|
540
592
|
|
|
541
593
|
When the catalog renames the free variant, change only the default selector
|
|
542
594
|
constant. Until then, a plain launch on that default stops with an error. A
|
package/cli/docs/platforms.md
CHANGED
|
@@ -1,19 +1,21 @@
|
|
|
1
1
|
# Platform support
|
|
2
2
|
|
|
3
|
-
The supported host matrix is exact:
|
|
3
|
+
The supported host matrix is exact: Linux on x64 and arm64, macOS on arm64,
|
|
4
|
+
and Windows on x64.
|
|
4
5
|
|
|
5
6
|
| Platform | Architecture | docks-kit binary | Sync engine |
|
|
6
7
|
|----------|--------------|------------------|-------------|
|
|
7
8
|
| Linux | x64 | `docks-kit-linux-x64` | EngineNative (TS) |
|
|
8
9
|
| Linux | arm64 | `docks-kit-linux-arm64` | EngineNative (TS) |
|
|
9
|
-
| macOS | x64 | `docks-kit-darwin-x64` | EngineNative (TS) |
|
|
10
10
|
| macOS | arm64 | `docks-kit-darwin-arm64` | EngineNative (TS) |
|
|
11
11
|
| Windows | x64 | `docks-kit-windows-x64.exe` | EngineNative (TS) |
|
|
12
|
-
| Windows | arm64 | `docks-kit-windows-arm64.exe` | EngineNative (TS) |
|
|
13
12
|
|
|
14
13
|
POSIX hosts use the `docks-kit` launcher. Windows uses `docks-kit.ps1`.
|
|
15
14
|
Hosts outside this table fail before either launcher can fall back to Bun
|
|
16
|
-
source.
|
|
15
|
+
source. The POSIX launcher and `install.sh` read the architecture of the
|
|
16
|
+
shell with `uname -m`. On an Apple silicon Mac, a shell that runs under
|
|
17
|
+
Rosetta reports `x86_64` and gets the unsupported-host message, so run
|
|
18
|
+
docks-kit from a native arm64 shell.
|
|
17
19
|
|
|
18
20
|
EngineNative is the only supported engine on supported hosts.
|
|
19
21
|
`DOCKS_KIT_ENGINE=bash` exits with the removed-engine message and points at the
|