Merge pull request #380 from opticon454/feature/cli-catalog-consumers

feat(cli-registry): drive install.sh and the Docker agent image from the CLI catalogue
This commit is contained in:
Ark0N
2026-09-14 15:55:08 +02:00
committed by GitHub
22 changed files with 1905 additions and 446 deletions
+7
View File
@@ -187,6 +187,13 @@ const discoverySchema = z
.strict(),
npmPackage: z.string().max(200).optional(),
docsUrl: z.url().optional(),
// Requires a `reason` on purpose — see the field's own doc comment in types.ts. A
// dedicated agent-image layer with no stated reason is a silent id-keyed special case
// rebuilding itself inside the data this change moved it out of.
agentImageLayer: z
.object({ kind: z.literal('dedicated'), reason: z.string().min(1).max(300) })
.strict()
.optional(),
})
.strict(),
})
+8
View File
@@ -632,6 +632,10 @@ const PI: CliEntry = {
},
npmPackage: '@earendil-works/pi-coding-agent',
docsUrl: 'https://pi.dev',
agentImageLayer: {
kind: 'dedicated',
reason: 'installed with --ignore-scripts in its own layer, so the flag cannot leak to the shared block',
},
},
},
launch: {
@@ -846,6 +850,10 @@ const DEEPSEEK: CliEntry = {
},
npmPackage: '@deepseek-ai/dsh',
docsUrl: 'https://github.com/deepseek-ai/deepseek-harness',
agentImageLayer: {
kind: 'dedicated',
reason: 'needs pnpm alongside it (dsh plugin, issue #352) and a dsh-tui profile install',
},
},
},
launch: {
+16
View File
@@ -230,6 +230,22 @@ export interface CliDiscovery {
/** Package name for an npm-installable CLI. Display/tooling metadata only. */
npmPackage?: string;
docsUrl?: string;
/**
* Present when the agent Docker image (`docker/agent.Dockerfile`) cannot install this
* CLI in the shared `npm install -g` layer with the rest and needs its own hand-written
* layer instead — a flag that would leak into the shared install (pi's `--ignore-scripts`),
* a companion package (deepseek's `pnpm`), or not being on npm at all (antigravity, grok,
* omp ship standalone installers). `reason` is REQUIRED, not decorative: it is what
* `test/docker-agent-image-coverage.test.ts` prints when a layer for this id goes missing
* from the Dockerfile, and it is what keeps this a data field rather than the id-keyed
* table it replaced (`AGENT_IMAGE_SPECIAL_CASE_IDS` in `docker-hosts.ts`,
* `AGENT_IMAGE_SPECIAL_CASES` in `scripts/lib/cli-catalog.mjs` — two copies kept in step by
* hand, outside stock.ts, which is exactly what this registry exists to prevent).
* `agentImageNpmPackages()` (docker-hosts.ts) and its `.mjs` mirror both filter on its
* presence rather than an id, so the shared npm layer and the special-case layers can never
* silently disagree about which CLI belongs in which.
*/
agentImageLayer?: { kind: 'dedicated'; reason: string };
};
}
+64 -3
View File
@@ -25,6 +25,7 @@ import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
import fs from 'node:fs/promises';
import { dirname, isAbsolute, join, relative, resolve } from 'node:path';
import { enabledCliIds, getCli } from './config/cli-registry/registry.js';
import { STOCK_CLIS } from './config/cli-registry/stock.js';
import { fileURLToPath } from 'node:url';
import { homedir } from 'node:os';
import { createHash } from 'node:crypto';
@@ -488,8 +489,68 @@ export function buildDockerCreateArgs(ctx: DockerCreateContext): string[] {
* scripts/build-agent-image.mjs): `build -f <dockerfile> -t <image> [--no-cache]
* <contextDir>`. Kept pure + unit-testable; the caller prepends the engine binary.
*/
export function agentImageBuildArgs(dockerfile: string, image: string, contextDir: string, noCache = false): string[] {
return ['build', '-f', dockerfile, '-t', image, ...(noCache ? ['--no-cache'] : []), contextDir];
export function agentImageBuildArgs(
dockerfile: string,
image: string,
contextDir: string,
noCache = false,
buildArgs: Array<[string, string]> = []
): string[] {
return [
'build',
'-f',
dockerfile,
'-t',
image,
...(noCache ? ['--no-cache'] : []),
...buildArgs.flatMap(([name, value]) => ['--build-arg', `${name}=${value}`]),
contextDir,
];
}
/** Tokens allowed in an npm package name reaching a Dockerfile build arg unquoted. */
const SAFE_PACKAGE = /^[@A-Za-z0-9][@A-Za-z0-9/._-]*$/;
/**
* npm packages the agent image installs in its shared layer, from the STOCK catalogue.
*
* ⚠️ Stock, deliberately, NOT the merged registry. A user's `~/.codeman/clis.json` must not
* change what lands inside an image tagged `codeman/agent:base`, or two machines holding that
* same tag hold different images and every cache-hit decision downstream is a lie.
*
* ⚠️ An entry carrying `discovery.install.agentImageLayer` is excluded here — see that field's
* doc comment in `types.ts` for why some CLIs need their own hand-written Dockerfile layer
* instead of the shared one, and `test/docker-agent-image-coverage.test.ts` for the guard that
* an exclusion here still lands in the Dockerfile somewhere.
*
* ⚠️ This mirrors `agentImageNpmPackages()` in `scripts/lib/cli-catalog.mjs`, which the CLI
* build path uses because a `.mjs` cannot import TypeScript. Two producers of one command
* line drift; `test/agent-image-build-args-parity.test.ts` is what stops them — including the
* SAFE_PACKAGE regex below, which is duplicated (not imported) in that file for the same
* reason and must stay byte-identical to it.
*/
export function agentImageNpmPackages(): string[] {
const packages: string[] = [];
for (const entry of STOCK_CLIS) {
if (!entry.enabled || entry.discovery.install.agentImageLayer) continue;
const pkg = entry.discovery.install.npmPackage;
if (!pkg) continue;
// The value is interpolated into a Dockerfile ARG expanded UNQUOTED (word splitting is
// how the list becomes several arguments), so a token with whitespace or shell
// metacharacters would change what the RUN line means. The source is `stock.ts`, so the
// practical risk is nil, but this is the in-app auto-build path and the only one of the
// two producers where that had gone unchecked.
if (!SAFE_PACKAGE.test(pkg)) {
throw new Error(`Refusing unsafe npm package name for "${String(entry.id)}": ${JSON.stringify(pkg)}`);
}
packages.push(pkg);
}
return packages;
}
/** The `--build-arg` pairs the agent image takes. */
export function agentImageBuildArgPairs(): Array<[string, string]> {
return [['CLI_NPM_PACKAGES', agentImageNpmPackages().join(' ')]];
}
// ========== Credential mount resolution (IO) ==========
@@ -1020,7 +1081,7 @@ function buildAgentImage(
const argv = dockerEngineArgv(docker);
const args = [
...argv.slice(1),
...agentImageBuildArgs(resolved.dockerfile, image, resolved.contextDir, opts.noCache),
...agentImageBuildArgs(resolved.dockerfile, image, resolved.contextDir, opts.noCache, agentImageBuildArgPairs()),
];
return new Promise<EnsureImageResult>((resolve) => {
// async spawn (NEVER spawnSync) so a multi-minute build never wedges the event loop.
+1 -1
View File
@@ -2941,7 +2941,7 @@
<div class="form-row docker-create-only">
<label>Image</label>
<input type="text" id="dockerImage" placeholder="codeman/agent:base" autocomplete="off" autocapitalize="off" spellcheck="false">
<span class="form-hint">Build it once with <code>node scripts/build-agent-image.mjs</code>. Contains node + claude/codex/gemini/opencode/agy/pi/grok/dsh + tmux.</span>
<span class="form-hint">Build it once with <code>node scripts/build-agent-image.mjs</code>. Contains node + claude/opencode/codex/gemini/agy/pi/grok/dsh/omp + tmux.</span>
</div>
<div class="form-row docker-create-only">
<label>Network</label>