docks-kit 0.24.0 → 0.26.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 +21 -136
- package/README.md +54 -9
- package/cli/dist/docks-kit.js +24688 -0
- package/cli/docs/command-guards.md +1 -1
- package/cli/docs/install.md +30 -9
- package/cli/docs/omp-context.md +1 -1
- package/cli/docs/omp-models.md +5 -4
- package/cli/docs/sync-layers.md +46 -75
- package/cli/docs/toolchain.md +4 -5
- package/cli/src/agentDocs/agentFirstCheck.ts +786 -0
- package/cli/src/agentDocs/bridgeCheck.ts +226 -0
- package/cli/src/agentDocs/commands.ts +63 -0
- package/cli/src/agentDocs/prTemplate.ts +211 -0
- package/cli/src/agentDocs/services.ts +202 -0
- package/cli/src/agentDocs/shared.ts +730 -0
- package/cli/src/agentDocs/verifySkill.ts +136 -0
- package/cli/src/argv.ts +25 -1
- package/cli/src/commands/agentDocs.ts +29 -0
- package/cli/src/commands/plan.ts +29 -0
- package/cli/src/commands/skill.ts +29 -0
- package/cli/src/commands/update.ts +90 -31
- package/cli/src/engine-native/DESIGN.md +5 -6
- package/cli/src/engine-native/engineCtx.ts +0 -3
- package/cli/src/engine-native/failures.ts +2 -2
- package/cli/src/engine-native/ompChild.ts +1 -1
- package/cli/src/engine-native/ompKitPlugin.ts +7 -16
- package/cli/src/engine-native/ompPlugins.ts +205 -221
- package/cli/src/engine-native/ompSync.ts +5 -14
- package/cli/src/generated/sotPayload.ts +308 -12
- package/cli/src/main.ts +12 -3
- package/cli/src/plan/bytes.ts +110 -0
- package/cli/src/plan/checkout.ts +341 -0
- package/cli/src/plan/commands.ts +1192 -0
- package/cli/src/plan/github.ts +816 -0
- package/cli/src/plan/records.ts +623 -0
- package/cli/src/plan/repository.ts +53 -0
- package/cli/src/plan/reviews.ts +292 -0
- package/cli/src/plan/services.ts +256 -0
- package/cli/src/plan/types.ts +164 -0
- package/cli/src/skills/commands.ts +142 -0
- package/cli/src/skills/config.json +30 -0
- package/cli/src/skills/files.ts +74 -0
- package/cli/src/skills/frontmatter.ts +148 -0
- package/cli/src/skills/guard.ts +366 -0
- package/cli/src/skills/kitGate.ts +406 -0
- package/cli/src/skills/rubric.ts +143 -0
- package/cli/tsconfig.json +1 -0
- package/package.json +7 -4
- package/cli/src/engine-native/ompMarketplace.ts +0 -140
package/AGENTS.md
CHANGED
|
@@ -2,42 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
Canonical instructions for coding agents working on this project. Compatible with Oh My Pi (`omp`), OpenCode, VS Code Copilot, and any other [agents.md](https://agents.md/)-aware tool.
|
|
4
4
|
|
|
5
|
-
Pointers here name concepts, not coordinates — if a path or symbol moved,
|
|
6
|
-
trust the stated purpose and re-locate it (grep the symbol) before acting.
|
|
5
|
+
Pointers here name concepts, not coordinates — if a path or symbol moved, trust the stated purpose and re-locate it (grep the symbol) before acting.
|
|
7
6
|
|
|
8
7
|
## Repository purpose
|
|
9
8
|
|
|
10
|
-
Portable configuration kit for AI coding agents. The kit manages one coding
|
|
11
|
-
harness, Oh My Pi (`omp`). Its Single Source of Truth (SoT) directory deploys
|
|
12
|
-
to omp's user-config location through `./docks-kit sync`. Sync writes no
|
|
13
|
-
`.agents` or `.claude` folder of its own; omp's folders follow
|
|
14
|
-
`PI_CONFIG_DIR`, `PI_CODING_AGENT_DIR`, and `XDG_DATA_HOME`, so an override
|
|
15
|
-
that points into one of those folders makes omp's files go there. Sync also
|
|
16
|
-
writes the kit plugin to `~/.docks-kit/omp-plugin`. Clone once to get a
|
|
17
|
-
consistent AI-assisted environment on supported Linux, macOS, and Windows
|
|
18
|
-
hosts. The kit focuses on **token efficiency without sacrificing quality**.
|
|
19
|
-
Every setting and hook minimizes token use while preserving rigorous output.
|
|
20
|
-
When you add or edit anything, ask: *does this change reduce tokens without
|
|
21
|
-
weakening correctness?*
|
|
9
|
+
Portable configuration kit for AI coding agents. The kit manages one coding harness, Oh My Pi (`omp`). Its Single Source of Truth (SoT) directory deploys to omp's user-config location through `./docks-kit sync`. Sync writes no `.agents` or `.claude` folder of its own; omp's folders follow `PI_CONFIG_DIR`, `PI_CODING_AGENT_DIR`, and `XDG_DATA_HOME`, so an override that points into one of those folders makes omp's files go there. Sync also writes the kit plugin to `~/.docks-kit/omp-plugin`. Clone once to get a consistent AI-assisted environment on supported Linux, macOS, and Windows hosts. The kit focuses on **token efficiency without sacrificing quality**. Every setting and hook minimizes token use while preserving rigorous output. When you add or edit anything, ask: *does this change reduce tokens without weakening correctness?*
|
|
22
10
|
|
|
23
11
|
omp uses this `AGENTS.md` file plus the omp SoT under `SoT/.omp/`.
|
|
24
12
|
|
|
25
|
-
docks-kit runtime and standalone binary support covers Linux x64/arm64, macOS
|
|
26
|
-
arm64, and Windows x64. Hosts outside this matrix fail before either
|
|
27
|
-
launcher can fall back to Bun source.
|
|
13
|
+
docks-kit runtime and standalone binary support covers Linux x64/arm64, macOS arm64, and Windows x64. Hosts outside this matrix fail before either launcher can fall back to Bun source.
|
|
28
14
|
|
|
29
15
|
## Context tree
|
|
30
16
|
|
|
31
|
-
Per-folder conventions live in nested `AGENTS.md` nodes. An agent can load
|
|
32
|
-
only the nodes from the root down to its working directory, so open the node
|
|
33
|
-
for the folder you edit from this table. Edit the node, not this list, when a
|
|
34
|
-
folder's rules change. `context-tree audit` checks this table against the
|
|
35
|
-
AGENTS.md files on disk.
|
|
17
|
+
Per-folder conventions live in nested `AGENTS.md` nodes. An agent can load only the nodes from the root down to its working directory, so open the node for the folder you edit from this table. Edit the node, not this list, when a folder's rules change. `context-tree audit` checks this table against the AGENTS.md files on disk.
|
|
36
18
|
|
|
37
19
|
| Node | Governs |
|
|
38
20
|
|---|---|
|
|
39
21
|
| `docs/AGENTS.md` | Plan-record routing to `docs/PLAN.md` |
|
|
40
|
-
| `cli/AGENTS.md` | Effect CLI, EngineNative sync engine, bundled docs topics, build scripts, unit and golden suites |
|
|
22
|
+
| `cli/AGENTS.md` | Effect CLI, EngineNative sync engine, bundled docs topics, build scripts, unit and golden suites, SoT notes |
|
|
41
23
|
| `.agents/skills/AGENTS.md` | Project skills; omp reads `.agents/skills/` directly |
|
|
42
24
|
|
|
43
25
|
## Repository layout (cross-cutting)
|
|
@@ -50,44 +32,21 @@ AGENTS.md files on disk.
|
|
|
50
32
|
| `SoT/toolchain.json` | Toolchain floors manifest (verified pins consumed by EngineNative; optional `upstream` source read by `docks-kit toolchain outdated`) |
|
|
51
33
|
| `SoT/.omp/` | Kit-owned omp SoT: `AGENTS.md`, `config.yml`, `models.yml`, `mcp.json`, `intercom.json`, and the kit plugin source `plugin/` |
|
|
52
34
|
| `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 |
|
|
35
|
+
| `.github/workflows/release-cli.yml` | `cli-v*` release: four binaries (Linux x64 and arm64, macOS arm64, Windows x64), plus `SHA256SUMS`, the bundle's source map `docks-kit.js.map`, and npm publish |
|
|
54
36
|
| `README.md` | Front door |
|
|
55
|
-
| `package.json` / `bun.lock` | npm package: `bin` = `cli/
|
|
56
|
-
| `docs/PLAN.md` | Plan
|
|
37
|
+
| `package.json` / `bun.lock` | npm package: `bin` = `cli/dist/docks-kit.js`, a minified bundle of the CLI and the generated in-memory SoT payload that `prepack` builds (`bun run build:bundle`); `cli/src` ships too, for the checkout launchers |
|
|
38
|
+
| `docs/PLAN.md` | Plan pointer and project plan rules. The plan record is a GitHub issue; no plan markdown is tracked. `docs/AGENTS.md` routes to it. |
|
|
57
39
|
| `AGENTS.md` | This file — tool-agnostic instructions |
|
|
58
40
|
|
|
59
41
|
Module map for `cli/` (engine axes, commands, kit store, test fixtures, and the release-binary build `bun run build:binaries`): `cli/AGENTS.md`.
|
|
60
42
|
|
|
61
|
-
|
|
62
|
-
- The global prompt SoTs carry the owner's standing authorization for Docks cross-company plan review, which never overrides host or platform denial.
|
|
63
|
-
|
|
64
|
-
omp SoT notes:
|
|
65
|
-
- `SoT/.omp/AGENTS.md`, `config.yml`, `models.yml`, and `mcp.json` deploy to `~/.omp/agent/`. omp loads `~/.omp/agent/AGENTS.md` only into main sessions and advisors, never into task subagents (`omp://context-files.md`). So `SoT/.omp/AGENTS.md` holds only main-session rules, and a command rule that subagents need goes into a kit plugin trigger rule.
|
|
66
|
-
- `SoT/.omp/intercom.json` deploys to `$PI_CODING_AGENT_DIR/intercom/config.json`. The default root is `~/.pi/agent`. Under a named omp profile (`OMP_PROFILE` or `PI_PROFILE`), it deploys to `<profile agentDir>/intercom/config.json`, because omp exports `PI_CODING_AGENT_DIR` as the profile agent directory.
|
|
67
|
-
- `ompFileDeploy.ts syncMergedYaml` deep-merges `config.yml` through `ompYaml.ts mergeOmpConfig` and `models.yml` through `mergeOmpModels`. Both wrap one generic mapping merge; only the config wrapper prunes stale `retry.fallbackChains` wildcards and merges `bash.patterns`.
|
|
68
|
-
- `SoT/.omp/config.yml` `bash.patterns` holds the destructive-command guards. omp 19.0.0 checks a deny rule, then a prompt rule, then its `CRITICAL_BASH_PATTERNS`, then an allow rule (`BashTool.approval` in the v19.0.0 source; `omp://approval-mode.md` still describes the 18.17.0 order, in which the critical check came before a prompt rule). A critical command that no deny or prompt rule matches gets a bare safety override, which replaces a matching allow, and omp's default `tools.approvalMode: yolo` ignores a bare override, so the command runs, in subagents too. A prompt rule asks a person, also on a critical command, but a subagent rejects every prompt. Every `rm` shape that the critical check can flag is therefore a deny: recursive `rm`, `sudo` anywhere before `rm` (also by path), any `rm` with an `r` or `f` option before an absolute path, and `--no-preserve-root`. By owner decision (0.20.9), the recursive-`rm` deny also covers any prefix (a `* rm ` copy of each bare cluster rule, so `env X=1 rm -rf b`, `xargs rm -rf`, `find . -exec rm -rf {} +`, and `git rm -r dir` are denied) and the `-ri`, `-ir`, `-Ri`, and `-iR` clusters for bare `rm`, `*/rm`, and `* rm`. By owner decision (0.21.0), 17 more denies cover bulk removal that can empty the home directory: `find -delete` (bare, `*/find`, `* find`), `-exec`, `-execdir`, `-ok`, and `-okdir` with `rm` or `*/rm`, and `xargs rm` in six shapes. No glob can express "inside the temporary directory", so `docks-kit scratch remove` checks that path in code. A `$` or a backtick anywhere after `git push` in the same command is a deny, not a prompt (0.22.5, #120). A variable can expand to a `+` refspec or `--force`, and the matcher reads the text before the shell expands it. The agent reads the refusal and writes the ref literally, so no person is asked. The two rules are `*git push *$*` and ``*git push *`*``. Their leading `*` keeps a shell keyword such as `do`, a wrapper such as `env`, or a path before `git` from hiding the push. By owner decision (0.22.8, #126), the kit ships no omp prompt rule: `bash.patterns` holds only the denies plus the `trash *` allow, so every command that no deny matches runs without a question, in subagents too. Since 0.20.9 this run-without-question behavior covers a non-denied `rm`, `git rm`, `git worktree remove`, and `gio trash`. Since 0.21.0 it also covers `docks-kit scratch remove`. Since 0.22.8 it also covers `git clean`, `git reset --hard`, a hook skip, and every `git push` that no deny matches. The force-push denies match only `git push --force` or `-f` directly before `origin main` or `origin master`, so another spelling, such as `git push origin main --force`, runs. A prompt rule that the user adds survives sync and still asks. The kit plugin trigger rules in `SoT/.omp/plugin/rules/` carry the agent rules for these commands. `git-safety.md` tells the agent to write each `git push` ref literally and to push the current branch with `git push -u origin HEAD`. The list order is deny, then `trash *`. For a command without shell control, omp takes the first matching rule. For a command with shell control, such as `;` or `|`, each segment takes its first matching deny or prompt rule, a deny chosen for one segment wins over a prompt chosen for another segment, and an allow never matches. A segment also matches without its leading `NAME=value` words. `ompYaml.ts mergeBashPatterns, grouped rule merge` keeps user rules and groups all rules as kit deny, user deny, user prompt, kit prompt, other user rules, kit allow, so a user deny or prompt precedes every kit allow. It treats a deployed rule equal to a kit rule (approval case-folded, `match` whitespace collapsed) as the kit copy, so a re-sync is a no-op. A rule the kit stops shipping stays as a user rule, so retire one through `ompRemovals.ts OMP_RETIRED_BASH_RULES`. `cli/test/lib/ompBashPatterns.ts` ports omp 19.0.0's matcher, critical patterns, and yolo resolution; `cli/test/unit/ompBashPatterns.test.ts` asserts each command's final outcome and the merge. omp subagents reject every `prompt`, and the `eval` tool stays unrestricted by owner decision.
|
|
69
|
-
- `ompSync.ts` runs `ompRemovals.ts syncOmpRemovals, retired-key inventory` right after the config merge, and that pass force-prunes retired kit-owned keys from `~/.omp/agent/config.yml` on every sync, with no flag. The pass is required because `mergeOmpConfig` is additive, so removing a key from the SoT alone never removes it from a deployed file. A key retired with a recorded value is pruned only while the deployed value still matches that value, so a user edit survives; a key retired outright, such as `providers.webSearchOrder`, is pruned at any value. The same pass removes each `bash.patterns` rule listed in `OMP_RETIRED_BASH_RULES`: the 39 file-removal rules retired in 0.20.9, the four `git push` prompts for a `$` or backtick word that 0.22.5 replaced with denies, and the 492 prompt rules retired in 0.22.8 (`RETIRED_PROMPT_MATCHES`). It compares with the merge's kit-rule normalization (approval case-folded, `match` whitespace collapsed), so a user rule with a different `match` or `approval` survives.
|
|
70
|
-
- `cycleOrder` ends with `astra` as its fifth stop. `modelRoles.astra` is `openai-codex/gpt-6.2-astra:xhigh`, and `modelTags.astra` (`GPT-6.2 Astra`) is visible. Astra and Fable fall back to each other through concrete selectors: `retry.fallbackChains.astra` holds `anthropic/claude-fable-5-2:medium`, and `retry.fallbackChains.fable` holds `openai-codex/gpt-6.2-astra:xhigh`. `modelRoles.fable` is `anthropic/claude-fable-5-2:medium`, with visible `modelTags.fable`. The hidden `switch_fable` role uses the same Fable selector and keeps an empty fallback chain.
|
|
71
|
-
- `modelRoles.task` is `anthropic/claude-opus-5-5:high`, and `retry.fallbackChains.task` falls back to `openai-codex/gpt-6.2-sol:high`. The kit relies on omp's default `task.enableEffort: false`: a caller `effort` outranks the role's level suffix, and `hi` maps to the top of the model ladder, so with the field on, `hi` spawns ran at the cap of the former kit value `task.maxEffort: xhigh` instead of the role level. With the field off, every spawn runs its role level, and `task.maxEffort` bounds only a per-call `model` with a `:level` suffix. Since 0.24.0 the kit sets no `task.maxEffort`, so that cap is omp's default `max`. By owner decision (0.22.22), the omp advisor is removed: the SoT has no `advisor` block, `advisor` role, or `advisor` fallback chain. The plan-lifecycle verification loop replaces a second model on every turn. A session that runs `/advisor on` takes its advisor model from the `slow` role. `smol`, `commit`, and `tiny` use `openai-codex/gpt-6-luna`. The kit-defined hidden `reviewer` role is `openai-codex/gpt-6.1-terra:high`. Its retry fallback is `anthropic/claude-opus-5-5:high`. All four reviewer entries in `task.agentModelOverrides` point to `@reviewer`. `task.agentServiceTierOverrides` sets the same four agents to `inherit`, so they take the live tier of the main session for each provider. The user set the effort `high` and chose to follow the fast toggle (#134); the review benchmark of #130 chose the model. `ompOverlay.ts ROLE_ORDER, FALLBACK_ORDER` list `reviewer`, so a free session also replaces it. omp bundles the `reviewer` and `security-reviewer` agents, and the `plan-lifecycle` plugin ships `code-reviewer` and `plan-reviewer`. The `SoT/toolchain.json` omp floor and verified pin are 19.0.0, the release the kit tested on 2026-11-19: its `omp models --json` catalog lists each model selector of `modelRoles` and `retry.fallbackChains` exactly, every `SoT/.omp/config.yml` key is a key of `omp config list --json`, and `cli/test/lib/ompBashPatterns.ts` ports its approval source. The floor is doctor visibility only. Sync does not check the omp catalog, so an older omp can fuzzy-match a missing id to another model. `cli/docs/omp-models.md` records the checks.
|
|
72
|
-
- The six Opus 5.5 roles (`default`, `slow`, `plan`, `designer`, `vision`, `task`) and the `smol`, `tiny`, `commit`, and `reviewer` retry chains use `anthropic/claude-opus-5-5` at the levels the role map records. `cli/docs/omp-models.md` carries the Artificial Analysis capture behind the role map, read 2026-09-29 at Intelligence Index v4.3.2 and Coding Agent Index v1.5 from the AA comparison-page metric tables. The `astra`, `reviewer`, `fable`, and `switch_fable` rows are the exceptions: they come from v5.0.1 captures read 2026-11-18 (GPT-6.2 Astra), 2026-11-05 (GPT-6.1 Terra), and 2026-11-12 (Fable 5.2), and they compare only with other v5.0.1 figures. Opus 5.5 max has the highest v4.3.2 index in that topic, at 58. AA has measured speed and latency for every Opus 5.5 level and every GPT-6.2 Sol and GPT-6.2 Astra row in that topic. GPT-6 Luna medium is the only unmeasured speed and latency row.
|
|
73
|
-
- `modelRoles.web` is `web/firecrawl` and `retry.fallbackChains.web` carries the explicit 20-entry provider order. The kit declares both keys because the legacy `providers.webSearchOrder` key is retired: omp expands it in memory into these two keys and then drops it, and never writes that expansion back to disk. An explicit chain replaces omp's built-in web order wholesale, so every entry left out is a provider omp never tries. The owner removed the seven entries that named older models (Gemini 2.5 Flash, Claude Haiku 4.5, GPT-5.6, GPT-5.5, and Grok 4.5); keep every other provider.
|
|
74
|
-
- `SoT/.omp/models.yml` declares Astra's full `low, medium, high, xhigh, max` ladder with `defaultLevel: xhigh` as the worked provider ladder-override example. The override is keyed `gpt-6.2-astra`, the model id of the `astra` role. `ompRemovals.ts syncOmpModelRemovals` prunes the old `gpt-6-astra` block from `~/.omp/agent/models.yml` while it equals the shipped block. The temporary `anthropic.modelOverrides.claude-opus-5-5` block is gone, because the shared catalog now publishes the same limits, ladder, and prices. The removal switches omp from the block's `thinking.mode: effort` (a `budget_tokens` value per level from `ANTHROPIC_THINKING`, no effort value) to the catalog's `anthropic-adaptive` (adaptive thinking with the role's effort level); every kit Opus selector names its level, so the block's bare-selector `defaultLevel: high` is not needed. `ompRemovals.ts syncOmpModelRemovals, retired-block inventory` prunes it from `~/.omp/agent/models.yml` after the models merge, but only while the deployed block still equals the shipped one. `ompYaml.ts mergeOmpModels` preserves deployed-only keys in `~/.omp/agent/models.yml`, because a user file may carry provider credentials. Whole-file replacement is wrong.
|
|
75
|
-
- `SoT/.omp/AGENTS.md` carries the rule `Please remove all mannered prose.` Anthropic's Fable 5.1 prompting guide documents mannered prose as a Fable 5.1 behavior and gives that sentence as its short-version fix: https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/prompting-claude-fable-5-1
|
|
76
|
-
- `cli/docs/omp-models.md` (topic `omp-models`) records the role map rationale and the Artificial Analysis snapshot behind it. Model choices change with published benchmarks, so update that topic in the same commit as a role change. For each model that an omp role or retry chain uses, the topic keeps AA rows at `high` and `xhigh` at least, with the index version and the capture date.
|
|
77
|
-
- `SoT/.omp/config.yml` carries only keys whose value differs from the omp default. When a kit value equals the omp default, remove the key from the SoT. Add it with its shipped value to `ompRemovals.ts OMP_RETIRED_VALUES`, because `ompYaml.ts mergeOmpConfig` is additive and only that pass prunes the deployed copy. For example, the kit ships no `compaction.thresholdTokens`, and sync prunes a deployed `-1` and the former `231200` pin. `cli/docs/omp-context.md` (topic `omp-context`) carries the reserve-based derivation and the measured evidence, so update that topic in the same commit as any compaction-setting change.
|
|
78
|
-
- Sync materializes the kit omp plugin `docks-kit-omp` from `SoT/.omp/plugin/` to `~/.docks-kit/omp-plugin` (`ompKitPlugin.ts syncKitPlugin`). It sets directories to 0700, files to 0600, and the `package.json` `version` to the kit version, and it removes stale files. It keeps no backups, because the directory is kit-owned. `ompPlugins.ts syncPlugins, kit plugin link` then runs `omp plugin link <dir>`. It skips the link when the `omp plugin list --json` npm row `docks-kit-omp` already has a `path` that resolves to that directory. `--skip-plugin-refresh` does not skip the link. The `hygiene.ts` extension registers `scratch_new`, `scratch_remove`, and `tidy_report`. It adds a reminder after each bash command that created a resource, and it checks at session stop that those resources are gone. At a main-session start, it claims `~/.cache/docks-kit/tidy.stamp.claim` and runs `docks-kit tidy --apply` in the background at most once per 12 hours. Every extension subprocess runs without a shell. The `pluginUpgrades.ts` extension reads the omp plugin upgrade log. In a tool result of each main session, it adds one reminder for the logged upgrades that the session did not get before. It names only the upgrades that finished after its omp process started. The reminder tells the agent to ask the user to run `/reload-plugins`. It then tells the agent to read each plugin skill again through `skill://` before it runs a skill script. It asks for a restart instead when an upgraded plugin ships hooks, extension modules, or non-MCP tools. omp imports extensions only at startup. An omp process that started before a sync deployed `pluginUpgrades.ts` did not load it, so its sessions get no reminder. The plugin also ships the `workspace-hygiene` skill, the `/cleanup` command, and six omp Time Traveling Stream Rules (TTSR, trigger rules) in `rules/`: `file-removal.md`, `git-safety.md`, `temp-and-background.md`, `worktree-location.md`, `literal-paths.md`, and `remote-cleanup.md`. omp's `omp-plugins` provider loads `rules/*.md` from the linked plugin root (`omp://plugin-manager-installer-plumbing.md`). Each rule has a regex `condition` scoped to `tool:bash, tool:eval` that aims at the wrong form; eval is in scope because eval code can run a shell command through `sh()`. A condition reads text, not a parsed command, so it has known false positives: a quoted command word (`echo "rm x"`, or a commit message that starts with `rm`) and eval code after the closing quote of a `sh()` string. `worktree-location.md` fires on each `git worktree add`, also at the correct path, because a condition cannot read `$XDG_DATA_HOME` or the home directory. omp aborts the matching tool call before it runs, injects the rule, and retries (`omp://ttsr-injection-lifecycle.md`). Each rule has `repeatMode: always`: it fires at each later wrong form, but not on the retry that its own reminder starts. The rules reach subagents and cost no prompt tokens until they fire. They teach the correct form; the `bash.patterns` denies still enforce. omp tests each condition on the partial argument buffer after each streamed delta, so a condition must not match a prefix of a correct command: it needs a delimiter after each token it checks, never the end anchor `$`. The buffer is the argument JSON text, the intent field `i` can come before or after `command`, and a provider can put JSON white space around the colon (`{"command": "ls"}`). So each condition starts its match with the forward key prefix `"(?:command|code)"\s*:\s*"[^"\\]*?` and an escape loop that takes up to 8 escape pairs per step; `cli/docs/command-guards.md` shows the full prefix. Only the key prefix is sure to stay inside the `command` or `code` string. The rest of a condition can cross the closing quote: the `Bun.file` condition of `file-removal.md` matches `{"code":"Bun.file(","i":").delete("}`. omp's `Matched:` excerpt is a bounded window around the match start: up to 60 characters before it, and a long match is cut at 180 characters from its start, so in a long call the trigger can be outside the excerpt. A scan stops at an unescaped `"` and at a newline (`\n`), a tab (`\t` in the buffer) counts as shell white space, and a scan that looks for an option stops at a ` -- ` word. omp runs each test on its main thread, in JavaScriptCore. Up to 0.22.29, each condition started with an unbounded lookbehind, which walked back over the buffer from every position. A 20 KB call then froze the session for seconds, and past the JavaScriptCore match limit the rule did not fire. So never start a condition with an unbounded lookbehind. Make each scan after a command start one lazy walk that stops at its first event: `(?=(?<w>[\s\S]*?)(?=EVENT)BOUNDARY)\k<w>`. The events are the flag of the condition, a terminator, the end of the run, and the next command start, each at a real token boundary. The lookahead does not backtrack after it matches, so the walk stays frozen. The stop at the next command start keeps a line that repeats a command start linear. Never put a group loop inside a lookaround over text of unbounded length, because JavaScriptCore then keeps each loop step until the match attempt ends and drops out of the JIT. omp tests open buffers that stop before the closing quote, so a scan must not rely on that quote to stop. `cli/test/unit/ompTriggerRules.test.ts` pins every condition through bash and through Python and JavaScript eval `sh()` calls, in the compact and the spaced JSON layouts, with some rows in the pretty layout and trigger words in the intent before and after the command. It checks that each condition has a wrong row that fires it and that each rule has `repeatMode: always`. Its shape guard checks only the key prefix and that no `|` stands outside every group. Its backstop runs `cli/test/lib/ompTriggerBackstop.ts` under Bun and tests the measured input families for linear time: a time budget, a fire check, scaling with the JIT off, and dense and head-and-run lines with the JIT on, in bash, open bash, and Python. A condition can still backtrack on a run that no generator holds, so a new condition needs a new family when its shape is new. Run `bunx vitest run cli/test/unit/ompTriggerRules.test.ts` after each condition change; it runs both guards. When you rewrite a condition, run the old and the new condition on each buffer of the test table and compare the results. `cli/docs/command-guards.md` (topic `command-guards`) lists the rules, the false positives, and the input families that a forward key prefix alone does not make linear. The plugin, the deployed rules, and the sweep call `docks-kit scratch` and `docks-kit tidy`. So a checkout sync must not run before the global `docks-kit` carries those commands.
|
|
79
|
-
- By owner decision (0.24.0), `astGrep.enabled` and `checkpoint.enabled` are `true`, so omp offers the `ast_grep` tool and the `checkpoint` and `rewind` tools. `rewind` restores only the conversation, and a rule line in `SoT/.omp/AGENTS.md` says so. The memory backend, `autolearn.enabled`, and `prewalk.enabled` stay off. Every other omp 19.0.0 feature keeps its omp default. The owner also returned 18 kit overrides to the omp defaults, for example `task.agentIdleTtlMs` (omp parks an idle subagent after 7 minutes) and `browser.idleCloseSec`. `OMP_RETIRED_VALUES` prunes each deployed key while it still holds the value that the kit shipped. `cli/docs/omp-context.md` lists the 18 keys, the kept overrides, and why `issue://` and `pr://` still work with `github.enabled` at its default `false`.
|
|
80
|
-
- By owner decision (0.21.0), resources on the workstation are always development, so `docks-kit tidy` sweeps them without a question. The omp `remote-cleanup.md` trigger rule, the `workspace-hygiene` skill, `/cleanup`, and the extension reminders limit the cleanup of a remote resource (reached through SSH, a database client, or a provider CLI such as `wrangler`, `vercel`, `kubectl`, `aws`, 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.
|
|
81
|
-
- 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.
|
|
82
|
-
- omp plugin upgrade flow, the `pi-intercom` install, and the `docks-kit omp` free-model launcher: `cli/AGENTS.md`.
|
|
83
|
-
|
|
84
|
-
For the omp SoT layout (`SoT/.omp/`), see that directory.
|
|
43
|
+
SoT notes (the shared prompt authorization, the omp deploy targets, the config and model merges, the retired inventories, the role map, the kit plugin sync, and the cleanup scope): `cli/AGENTS.md` (`### SoT notes`).
|
|
85
44
|
|
|
86
45
|
## Engineering rules
|
|
87
46
|
|
|
88
47
|
- **EngineNative and CLI rules** (idempotency, failure ledger, removed bash engine, Effect stack and skill routing, kit store, module boundaries): `cli/AGENTS.md`.
|
|
89
48
|
- **One sync.** `./docks-kit sync` deploys the omp SoT and takes no positional target. Combine it with `--dry-run`, `--skip-plugin-refresh` (install missing omp plugins without refreshing existing ones), and `--verbose`.
|
|
90
|
-
- **Additive by default.** Keys present in deployed config but absent from SoT are preserved on default sync. This protects user-only additions, but means drift accumulates. The exceptions are the omp retired inventories: `ompRemovals.ts` force-prunes retired kit-owned keys, `bash.patterns` rules, and model blocks on every sync (see the omp SoT notes
|
|
49
|
+
- **Additive by default.** Keys present in deployed config but absent from SoT are preserved on default sync. This protects user-only additions, but means drift accumulates. The exceptions are the omp retired inventories: `ompRemovals.ts` force-prunes retired kit-owned keys, `bash.patterns` rules, and model blocks on every sync (see the omp SoT notes in `cli/AGENTS.md`). Sync has no removal flag.
|
|
91
50
|
- **Small, reviewable changes.** Bundled multi-concern PRs are harder to review and revert. Split an engine/CLI change and a per-tool config change unless the change requires atomicity.
|
|
92
51
|
- **Version bumps.** Bump `package.json` on user-visible behavior change; bump a `SoT/toolchain.json` `verified` pin only after testing that release. Refactors, splits, and doc edits bump nothing.
|
|
93
52
|
- **Regenerate the payload.** After `SoT/` or `package.json` changes, run `bun cli/scripts/generate-sot-payload.ts`; `bun run check:generated` verifies it. After file moves, clamp cited `metadata.source_files[].lines` ranges so `skillMetadata.test.ts` passes.
|
|
@@ -104,8 +63,8 @@ For the omp SoT layout (`SoT/.omp/`), see that directory.
|
|
|
104
63
|
|
|
105
64
|
- No secrets in SoT. The kit's SoT directories are committed; treat them as declarative config only.
|
|
106
65
|
- Treat external plugin marketplaces and installer downloads as untrusted input. Prefer download-then-run over `curl … | bash` so a truncated stream cannot execute a partial script.
|
|
107
|
-
- **Pin, never float.** Every kit-driven install of third-party software is pinned to a `SoT/toolchain.json` `verified` version, except the
|
|
108
|
-
- **
|
|
66
|
+
- **Pin, never float.** Every kit-driven install of third-party software is pinned to a `SoT/toolchain.json` `verified` version, except the exemption in the next item — no `@latest` npm/bun installs (Shai-Hulud-class worm surface), no mutable action tags in workflows (commit SHAs only), installer scripts fetched from version tags where upstream supports it. New third-party install surface ⇒ manifest pin first. The rule also covers a transitive dependency whose declared range is a caret or tilde over a prerelease: `^4.0.0-rc.109` admits every later prerelease of the same version tuple, and a published install resolves that range fresh because `bun.lock` is not packaged, so a runtime pinned in `package.json` meets a newer sibling and the process fails at startup. The fix is an exact root pin plus both guards: the offline `cli/test/unit/dependencyPins.test.ts` and the clean-room `bun run smoke:package`. Moving the Effect release is therefore one lockstep commit: set `effect`, `@effect/platform-bun`, and `@effect/platform-node-shared` to the same version together, then run `bun run smoke:package`. The offline guard fails when a lag breaks a declared range. Its peer-range check fails when the installed `effect` is outside a non-optional peer range of the runtime closure. Its nested-copy check fails when `@effect/platform-node-shared` lags. A lagging `@effect/platform-bun` can keep every declared range satisfied (4.1.1 accepts `@effect/platform-node-shared` `^4.1.1`), so only the lockstep commit keeps it in step. Details: the `toolchain-context` skill and `cli/docs/toolchain.md`.
|
|
67
|
+
- **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 `@latest` 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. Any new install surface, a new marketplace or plugin source included, needs a manifest pin first.
|
|
109
68
|
## Testing
|
|
110
69
|
|
|
111
70
|
Run `bun run check` before and after each change: oxlint, `lint:effect` (Effect rules through `effect-tsgo diagnostics --strict`), `bun fmt --check`, `bun check`, the generated-payload check (`check:generated`), unit tests, and both golden suites. Scripts: `lint`, `lint:effect`, `format:check`, `typecheck`, `check:generated`, `test:unit`, `test:integration` (goldens), `test`, `format`; CI runs `check` on pushes to `main` and on pull requests with Bun 1.4.4. Prove-red modes must exit non-zero after detecting planted mismatches. The golden writer emits two-space JSON that `bun fmt` re-serializes, so run `bun run format` after `--update-goldens` or `format:check` fails. For Effect diagnostics in the editor, set the TypeScript language server command to `node_modules/.bin/effect-tsgo tsc --lsp --stdio`. Keep the `@effect/language-service` plugin entry in `cli/tsconfig.json`: without it, `lint:effect` checks no file and passes. Also verify user-facing changes via `./docks-kit sync --dry-run` and `bun run smoke:native`.
|
|
@@ -126,87 +85,14 @@ Project-skill authoring rules (scope, canonical layout, vendored `unslop`, citat
|
|
|
126
85
|
|
|
127
86
|
**Vendored `unslop`.** The kit never runs the skills CLI. Only a maintainer refreshes the vendored `.agents/skills/unslop/` copy, with `npx skills@1.7.0 add cursor/plugins -s unslop -y -a universal`. The skills CLI 1.7.0 installs the `universal` agent into the project path `.agents/skills/`, which omp reads.
|
|
128
87
|
|
|
88
|
+
## Kit plugin content
|
|
89
|
+
|
|
90
|
+
`SoT/.omp/plugin/` holds skills at `skills/<name>/SKILL.md`, task agents at `agents/<name>.md`, and the extensions that `package.json` `omp.extensions` names. It ships the 32 docks and plan-lifecycle skills, the `workspace-hygiene` skill, the `code-reviewer` and `plan-reviewer` agents, the `hygiene`, `verify-gate`, and `context-tree-nudge` extensions, the trigger rules in `rules/`, and the `/cleanup` command. A skill reports a problem in DocksDocks/docks-kit. `bun run check` checks this content with four tests in `cli/test/unit/plugin/`: `skills.test.ts` (layout and name, frontmatter, report section, shared copies, references, durable anchors, transform guard, trigger collisions, score floor), `contentHash.test.ts`, `agents.test.ts` (agent rules, score floor), and `extensions.test.ts` (each entry imports and has a default function export).
|
|
91
|
+
After a skill edit, run `bun cli/scripts/skill-content-hash.ts --write` to refresh its `metadata.content_hash` and `metadata.updated`; `--check` names each stale skill. The skill checks, the 16-point rubric, and the check data in `config.json` (floors, report section, shared-copy groups, transform list) are in `cli/src/skills/`, which `docks-kit skill guard` and `docks-kit skill score` also use; the agent, reference, trigger, extension, and content-hash checks are in `cli/scripts/pluginContent/`.
|
|
92
|
+
|
|
129
93
|
## Plans
|
|
130
94
|
|
|
131
|
-
Use direct implementation for
|
|
132
|
-
bounded acceptance path; it creates no plan issue, reviewer, or automatic
|
|
133
|
-
commit. Use a canonical plan for explicit planning, multi-commit or
|
|
134
|
-
cross-repository work, cold handoff, an unresolved decision, a cross-subsystem or
|
|
135
|
-
public-contract change, security-sensitive or destructive work, or any
|
|
136
|
-
non-`local` effect.
|
|
137
|
-
|
|
138
|
-
<constraint>
|
|
139
|
-
The plan record is a GitHub issue. Its body starts with
|
|
140
|
-
`<!-- plan-contract: v4 -->`, followed by one blank line and seven `##`
|
|
141
|
-
sections. It has no frontmatter. GitHub owns the title, open-work phase, owner,
|
|
142
|
-
timestamps, and completion. The repository tracks no plan markdown.
|
|
143
|
-
Three skills own the workflow. `plan-workspace` maintains the workspace.
|
|
144
|
-
Main-context `plan-manager` runs six phases: decide, draft, research, plan
|
|
145
|
-
review, implement, and code review. It uses bounded repair and fresh re-review
|
|
146
|
-
in both review phases, then archives. Internal `plan-reviewer` returns one
|
|
147
|
-
readable pre-implementation verdict block per round. Two read-only reviewer
|
|
148
|
-
wrappers ship: `plan-reviewer` and `code-reviewer`.
|
|
149
|
-
The explicit-only `yolo` skill runs the same workflow. It still asks before merge, on a review stall, before a production cleanup, and before a step after the landing merge, as the contract's Yolo runs section says.
|
|
150
|
-
</constraint>
|
|
151
|
-
|
|
152
|
-
After the marker and blank line, the record carries exactly seven sections.
|
|
153
|
-
They appear once each in this order: `## Goal`, `## Research`, `## Steps`,
|
|
154
|
-
`## Acceptance`, `## Do not touch`, `## Open questions`, and
|
|
155
|
-
`## Verification Results`. `## Goal` carries exactly one mode line.
|
|
156
|
-
Open-work phase is `drafting`, `planned`, `ongoing`, or `blocked`.
|
|
157
|
-
Every plan carries `plan`. A `plan:<phase>` label stores the open phase.
|
|
158
|
-
A blocked plan starts `## Open questions` with `Blocked: <one-line reason>`.
|
|
159
|
-
GitHub `state` and `stateReason` determine closed status. Review records live
|
|
160
|
-
only in issue comments. Each reviewer returns one markdown block.
|
|
161
|
-
The manager posts that block as one issue comment. The latest trusted eligible
|
|
162
|
-
comment per review kind wins. Its author must equal the plan's sole assignee.
|
|
163
|
-
Both review phases use fresh inputs for each round. They stop on
|
|
164
|
-
pass. Ask the user to continue or block when a round makes no progress, the
|
|
165
|
-
same finding returns after a repair, round 5 does not pass, or dispatch fails
|
|
166
|
-
again without a relevant change. If no answer is available, record the reason
|
|
167
|
-
and block. A yolo run uses the round ceiling of the contract's Yolo runs
|
|
168
|
-
section instead.
|
|
169
|
-
A plan-review `blocked` verdict routes its user-only decision through
|
|
170
|
-
`## Open questions` and `ask`.
|
|
171
|
-
|
|
172
|
-
The record carries no hash, permit, run identity, lock, or bundle, and the
|
|
173
|
-
`plan.mjs` shipped inside the installed `plan-lifecycle` plugin is the only
|
|
174
|
-
lifecycle tool. An `export` writes the sha256 of the body it copied beside the
|
|
175
|
-
copy so a stale copy cannot revert the record; that digest detects staleness and
|
|
176
|
-
authorizes nothing. Routine plan issue publication, implement-start linked
|
|
177
|
-
branch creation, commits, normal pushes, and the closing pull request carry the
|
|
178
|
-
settled mode's authorization and need no repeated prompt. Before any branch
|
|
179
|
-
checkout, including `gh issue develop --checkout`, require
|
|
180
|
-
`git status --porcelain` to be empty. If it is dirty, never stash, move, or
|
|
181
|
-
commit ambient work; set the plan `blocked` and name the dirty paths, or use an
|
|
182
|
-
authorized clean worktree.
|
|
183
|
-
Immediately after setting the plan `ongoing`, every `gh issue develop` call uses
|
|
184
|
-
`--repo`; the manager reuses a linked branch or creates one with
|
|
185
|
-
`--base <default> --checkout`, then re-lists and recovers after failure.
|
|
186
|
-
Implementation stops when no linked branch can be verified; there is no local
|
|
187
|
-
fallback. After the checks policy passes, the manager asks immediately before
|
|
188
|
-
merge. Without a fresh `Merge now` answer, it leaves the pull request and issue
|
|
189
|
-
open. `plan.mjs archive` verifies the latest trusted code-review result and
|
|
190
|
-
merged closing pull request after landing.
|
|
191
|
-
|
|
192
|
-
Every Steps row carries an `Effect` of exactly
|
|
193
|
-
`local|probe|production_access|publish|push|release|deploy`. A step whose
|
|
194
|
-
`Effect` is not `local` requires an in-session `ask` confirmation immediately
|
|
195
|
-
before it runs; when `ask` is unavailable the step is set `blocked` and the plan
|
|
196
|
-
reason becomes the first `## Open questions` line, `Blocked: <reason>`.
|
|
197
|
-
Persisted effects record intent only. Routine issue publication and landing
|
|
198
|
-
actions are outside the Steps table.
|
|
199
|
-
A user-invoked `yolo` run replaces these asks, the continue-or-block question of the review loop, and the `blocked`-verdict question with the Yolo runs section of the installed `plan-lifecycle` contract.
|
|
200
|
-
|
|
201
|
-
Render a plan body verbatim only when the user names that plan and asks to see it. After a write, report the one-line header strip and the changed lines only; a write never re-renders the body.
|
|
202
|
-
|
|
203
|
-
No plan markdown is tracked. The pre-GitHub records under
|
|
204
|
-
`docs/plans/finished/` were deleted; `git log -- docs/plans/finished/` recovers
|
|
205
|
-
them as history, and no lifecycle command restores them. The complete contract
|
|
206
|
-
lives in `docs/PLAN.md`; `docs/AGENTS.md` routes to it.
|
|
207
|
-
|
|
208
|
-
Plugin-internal work (skills, commands, agents) belongs in each plugin's
|
|
209
|
-
own repo, not here.
|
|
95
|
+
Read `docs/PLAN.md` before plan work; `docs/AGENTS.md` holds the docs-folder rules. The canonical contract is `skill://plan-manager/references/plan-contract.md` in the docks-kit kit plugin. Use `plan-workspace` for setup, main-context `plan-manager` for the six phases, and read-only `plan-reviewer` and `code-reviewer` wrappers for review. Use direct implementation only for a clear, reversible, low-risk local diff with one bounded acceptance path. Otherwise follow the plan-manager decision. Plan issues are the live records. Leave `docs/plans/finished/` frozen.
|
|
210
96
|
|
|
211
97
|
## Notes for nested overrides
|
|
212
98
|
|
|
@@ -216,12 +102,11 @@ Per the agents.md open standard, place an `AGENTS.md` inside any subdirectory th
|
|
|
216
102
|
|
|
217
103
|
```bash
|
|
218
104
|
# Clone and sync the kit
|
|
219
|
-
git clone <this-repo> ~/projects/
|
|
220
|
-
cd ~/projects/
|
|
105
|
+
git clone <this-repo> ~/projects/docks-kit
|
|
106
|
+
cd ~/projects/docks-kit
|
|
221
107
|
./docks-kit sync --dry-run # preview before applying
|
|
222
108
|
./docks-kit sync # deploy the omp SoT (additive)
|
|
223
109
|
./docks-kit toolchain check # verify installed tools against SoT/toolchain.json floors
|
|
224
110
|
```
|
|
225
111
|
|
|
226
|
-
On Windows, replace `./docks-kit` with `.\docks-kit.ps1` in these checkout
|
|
227
|
-
commands.
|
|
112
|
+
On Windows, replace `./docks-kit` with `.\docks-kit.ps1` in these checkout commands.
|
package/README.md
CHANGED
|
@@ -11,8 +11,8 @@ Supported harness: **Oh My Pi (`omp`)**.
|
|
|
11
11
|
## Quick start
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
git clone https://github.com/DocksDocks/
|
|
15
|
-
cd ~/projects/
|
|
14
|
+
git clone https://github.com/DocksDocks/docks-kit.git ~/projects/docks-kit
|
|
15
|
+
cd ~/projects/docks-kit
|
|
16
16
|
./docks-kit sync # deploy the omp SoT
|
|
17
17
|
./docks-kit sync --dry-run # preview the sync without a write
|
|
18
18
|
./docks-kit toolchain # doctor view: verified-version floors for external tools
|
|
@@ -40,6 +40,23 @@ upstream installer when Bun is absent: by the POSIX launcher and installer, and
|
|
|
40
40
|
by sync's Bun bootstrap, which a release binary can also run. The Windows
|
|
41
41
|
launcher and installer use Invoke-WebRequest.
|
|
42
42
|
|
|
43
|
+
### Move a checkout of DocksDocks/public
|
|
44
|
+
|
|
45
|
+
The kit moved from DocksDocks/public to DocksDocks/docks-kit. To move a
|
|
46
|
+
checkout of DocksDocks/public, run these commands from the checkout's root:
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
git remote set-url origin https://github.com/DocksDocks/docks-kit.git
|
|
50
|
+
./docks-kit update # Linux and macOS
|
|
51
|
+
.\docks-kit.ps1 update # Windows
|
|
52
|
+
./docks-kit sync # Linux and macOS
|
|
53
|
+
.\docks-kit.ps1 sync # Windows
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The update pulls from DocksDocks/docks-kit. The sync then deploys the skills
|
|
57
|
+
with their new report target: a launcher that runs a fresh compiled binary
|
|
58
|
+
skips the sync that the update chains. A global npm install needs nothing.
|
|
59
|
+
|
|
43
60
|
## CLI
|
|
44
61
|
|
|
45
62
|
```text
|
|
@@ -102,6 +119,31 @@ Full reference: `docks-kit docs flags`.
|
|
|
102
119
|
omp plugin `docks-kit-omp` exposes these as tools, reminds the agent of
|
|
103
120
|
what it created, and runs the sweep at most once per 12 hours.
|
|
104
121
|
|
|
122
|
+
## Kit plugin
|
|
123
|
+
|
|
124
|
+
Sync writes the kit plugin `docks-kit-omp` to `~/.docks-kit/omp-plugin` and
|
|
125
|
+
links it into omp. The kit plugin content comes from `SoT/.omp/plugin/`:
|
|
126
|
+
|
|
127
|
+
- **Skills** — the 32 docks and plan-lifecycle skills, for example
|
|
128
|
+
`plan-manager`, `plan-workspace`, `code-review`, `security`, and
|
|
129
|
+
`refactor`, plus the `workspace-hygiene` skill.
|
|
130
|
+
- **Agents** — the `code-reviewer` and `plan-reviewer` task agents.
|
|
131
|
+
- **Extensions** — `verify-gate` checks that each `git commit` carries a
|
|
132
|
+
`Verified:` trailer, `context-tree-nudge` names the context-tree node of
|
|
133
|
+
each edited file, and `hygiene` gives the agent cleanup tools and
|
|
134
|
+
reminders.
|
|
135
|
+
- **Rules and commands** — six trigger rules that teach the safe form of a
|
|
136
|
+
risky command, and the `/cleanup` command.
|
|
137
|
+
|
|
138
|
+
The kit plugin replaces the former `docks` and `plan-lifecycle` plugins of
|
|
139
|
+
the `docks` marketplace. `docks-kit sync` uninstalls their user-scope installs
|
|
140
|
+
when it can read the omp plugin inventory, and then removes the `docks`
|
|
141
|
+
marketplace when no uninstall failed and it can read the marketplace registry.
|
|
142
|
+
It only warns about a project-scope install, with the manual command. When a
|
|
143
|
+
read fails, sync warns and skips that step, and a later sync tries again.
|
|
144
|
+
Report a problem with a skill, an agent, or the kit in
|
|
145
|
+
[DocksDocks/docks-kit](https://github.com/DocksDocks/docks-kit/issues).
|
|
146
|
+
|
|
105
147
|
## Repository map
|
|
106
148
|
|
|
107
149
|
| Path | Purpose |
|
|
@@ -113,7 +155,7 @@ Full reference: `docks-kit docs flags`.
|
|
|
113
155
|
| `cli/` | docks-kit CLI (Effect 4 on Bun) + bundled docs topics |
|
|
114
156
|
| `docks-kit` / `docks-kit.ps1` | POSIX and Windows launchers (binary → Bun-from-source) |
|
|
115
157
|
| `install.sh` / `install.ps1` | POSIX and Windows global installers |
|
|
116
|
-
| `docs/PLAN.md` | Plan
|
|
158
|
+
| `docs/PLAN.md` | Plan pointer and project plan rules; plans are GitHub issues |
|
|
117
159
|
| `AGENTS.md` | Agent-facing engineering rules |
|
|
118
160
|
|
|
119
161
|
## Platform support
|
|
@@ -131,13 +173,16 @@ Details: `docks-kit docs platforms`.
|
|
|
131
173
|
|
|
132
174
|
Tagging `cli-v*` builds four standalone binaries: `docks-kit-linux-x64`,
|
|
133
175
|
`docks-kit-linux-arm64`, `docks-kit-darwin-arm64`, and
|
|
134
|
-
`docks-kit-windows-x64.exe`. The workflow attaches them plus `SHA256SUMS`
|
|
135
|
-
|
|
136
|
-
with OIDC provenance.
|
|
176
|
+
`docks-kit-windows-x64.exe`. The workflow attaches them plus `SHA256SUMS` and the
|
|
177
|
+
bundle's source map `docks-kit.js.map` to the GitHub release. npm publishes the
|
|
178
|
+
exact package tarball through trusted publishing with OIDC provenance.
|
|
137
179
|
Published binaries, checksums, and release notes are available on
|
|
138
|
-
[GitHub Releases](https://github.com/DocksDocks/
|
|
139
|
-
Each `docks-kit` npm release
|
|
140
|
-
|
|
180
|
+
[GitHub Releases](https://github.com/DocksDocks/docks-kit/releases).
|
|
181
|
+
Each `docks-kit` npm release runs one minified JavaScript bundle of the CLI and
|
|
182
|
+
its generated payload (`cli/dist/docks-kit.js`), so releases are versioned config
|
|
183
|
+
snapshots without shipping the authoring `SoT/` tree. The package does not ship
|
|
184
|
+
the source map; the bundle's last line `//# debugId=<hex>` matches the map of
|
|
185
|
+
the same release.
|
|
141
186
|
|
|
142
187
|
## Deeper docs
|
|
143
188
|
|