mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-06 20:05:57 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Adapter packages are the bridge between the control plane and local agent harnesses such as Claude Code, Codex, and Gemini CLI. > - ACP support was concentrated in a separate `acpx_local` adapter, which made ACP feel like a separate agent choice instead of an execution capability of the harness adapters. > - Claude, Codex, and Gemini now have ACP-capable harnesses, so the native adapter should own ACP selection, fallback, config, transcript parsing, and environment diagnostics. > - The standalone ACPX adapter still needs a compatibility path for existing rows, but it should not be offered as an active adapter for new agents. > - This pull request moves the shared ACP runtime into `@paperclipai/acpx-engine`, wires Claude/Codex/Gemini local adapters to prefer ACP when prerequisites are available, and retires `acpx_local` to a tombstone. > - The benefit is one adapter per harness, richer ACP transcripts by default where possible, and a migration path for existing Claude/Codex ACPX agents. ## Linked Issues or Issue Description Closes #5932 — the broken default `acpx_local` Claude path is replaced by native `claude_local` ACP support, existing Claude/Codex ACPX rows migrate to native adapters, and new agents no longer choose the standalone ACPX adapter. Refs #4893 — original merged ACPX local adapter runtime that this PR replaces with native per-harness ACP engines. Refs #6590 — prior ACPX-Claude seamlessness work folded into the new native Claude ACP path. Refs #197 — related open generic ACP/Kiro adapter work; this PR does not close it because Kiro/custom generic ACP remains a separate adapter decision. Refs #7018 — related Kimi-specific `acpx_local` shell failure; this PR retires the built-in standalone adapter but does not add a native Kimi adapter. Refs #8864 — related ACPX prompt/API guidance PR; this PR moves runtime guidance into the shared/native ACP engine path instead of the old standalone adapter. Refs #8881 — related `acpx_local` POSIX shell failure from the old `acpx` pin; this PR updates ACP dependencies but does not claim custom/OMP ACP support as a first-class native adapter. Refs #8964 — related open `acpx_local` stderr cleanup PR; this PR makes the old runtime path obsolete for new agents but keeps it as a non-closing reference. Problem description: - The standalone `acpx_local` adapter duplicates Claude/Codex agent choices that already have first-class local adapters. - ACP should be an execution engine capability of each harness adapter when the underlying harness supports ACP. - Existing `acpx_local` agents should either migrate to native harness adapters or fail with an explicit retirement message instead of silently falling back to the process adapter. ## What Changed - Added `@paperclipai/acpx-engine` as the shared ACP execution, session-codec, CLI formatter, and UI parser package. - Wired `claude_local`, `codex_local`, and `gemini_local` to auto-select ACP by default when prerequisites pass, with `engine=cli` opt-out and `engine=acp` strict mode. - Added ACP config schema/UI fields, environment checks, session-codec preservation, transcript parsing, and adapter capability metadata for the native adapters. - Retired `acpx_local` to a server tombstone, removed its UI/package/runtime image surface, and added a migration for existing Claude/Codex ACPX agents. - Updated package manifests, lockfile, release tooling, docs, Kubernetes sandbox defaults, and tests. ## Verification - `corepack pnpm --filter @paperclipai/acpx-engine typecheck` - `corepack pnpm --filter @paperclipai/adapter-claude-local typecheck` - `corepack pnpm --filter @paperclipai/adapter-codex-local typecheck` - `corepack pnpm --filter @paperclipai/adapter-gemini-local typecheck` - `corepack pnpm --filter @paperclipai/acpx-engine exec vitest run` - `corepack pnpm --filter @paperclipai/adapter-claude-local exec vitest run src/server/acp.test.ts src/server/execute.acp-fallback.test.ts src/ui/build-config.test.ts` - `corepack pnpm --filter @paperclipai/adapter-codex-local exec vitest run src/server/acp.test.ts src/ui/build-config.test.ts` - `corepack pnpm --filter @paperclipai/adapter-gemini-local exec vitest run src/server/acp.test.ts src/ui/build-config.test.ts src/ui/parse-stdout.test.ts` - `corepack pnpm --filter @paperclipai/plugin-sdk ensure-build-deps && corepack pnpm --filter @paperclipai/server exec tsc --noEmit` - `corepack pnpm --filter @paperclipai/server exec vitest run src/__tests__/adapter-routes.test.ts src/__tests__/adapter-session-codecs.test.ts src/__tests__/adapter-models.test.ts` - `corepack pnpm --filter @paperclipai/ui typecheck` - `corepack pnpm --filter @paperclipai/ui exec vitest run src/adapters/metadata.test.ts src/adapters/adapter-display-registry.test.ts src/components/AgentConfigForm.test.ts src/components/AgentConfigForm.render.test.tsx src/components/transcript/RunTranscriptView.test.tsx` - `node --test scripts/bootstrap-npm-package.test.mjs scripts/release-package-map.test.mjs scripts/verify-release-registry-state.test.mjs` Note: the server typecheck script calls `pnpm` internally; this dev shell exposes pnpm through Corepack only, so I ran the two script steps manually with `corepack pnpm`. ## Risks - Migration changes existing `acpx_local` Claude/Codex agents to native adapter types and clears old ACPX task sessions/runtime state. - Custom ACP commands remain on the retired tombstone and will need a separate future adapter/plugin path. - ACP auto-selection depends on local Node and ACP server command prerequisites; remote and unsupported environments fall back to CLI unless `engine=acp` is explicit. - `@paperclipai/acpx-engine` is a new public package and needs npm trusted-publishing bootstrap before release automation can publish it. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used OpenAI GPT-5 via Codex coding agent. Exact hosted model build and context-window size are not exposed in this runtime. Tool use included shell execution, repository editing, GitHub CLI operations, and local test/typecheck execution. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
307 lines
8.2 KiB
JavaScript
307 lines
8.2 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
import { spawnSync } from "node:child_process";
|
|
import { fileURLToPath } from "node:url";
|
|
import { dirname, resolve } from "node:path";
|
|
|
|
import { buildReleasePackagePlan } from "./release-package-map.mjs";
|
|
|
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
const repoRoot = resolve(__dirname, "..");
|
|
|
|
function normalizePath(filePath) {
|
|
return filePath.replace(/\\/g, "/").replace(/^\.\//, "");
|
|
}
|
|
|
|
function usage() {
|
|
process.stderr.write(
|
|
[
|
|
"Usage:",
|
|
" node scripts/bootstrap-npm-package.mjs <package-name-or-dir> [--publish --otp <code>] [--skip-build]",
|
|
"",
|
|
"Examples:",
|
|
" node scripts/bootstrap-npm-package.mjs @paperclipai/plugin-workspace-diff",
|
|
" node scripts/bootstrap-npm-package.mjs packages/plugins/plugin-workspace-diff --publish",
|
|
"",
|
|
].join("\n"),
|
|
);
|
|
}
|
|
|
|
function parseArgs(argv) {
|
|
const flags = new Set();
|
|
let selector = null;
|
|
let otp = null;
|
|
|
|
for (let index = 0; index < argv.length; index += 1) {
|
|
const arg = argv[index];
|
|
if (arg === "--") {
|
|
continue;
|
|
}
|
|
|
|
if (arg === "--publish" || arg === "--skip-build") {
|
|
flags.add(arg);
|
|
continue;
|
|
}
|
|
|
|
if (arg === "--otp") {
|
|
const value = argv[index + 1];
|
|
if (!value || value.startsWith("--")) {
|
|
throw new Error("expected a one-time password after --otp");
|
|
}
|
|
otp = value;
|
|
index += 1;
|
|
continue;
|
|
}
|
|
|
|
if (arg === "--help" || arg === "-h") {
|
|
return { help: true, selector: null, publish: false, skipBuild: false, otp: null };
|
|
}
|
|
|
|
if (arg.startsWith("--")) {
|
|
throw new Error(`unknown option: ${arg}`);
|
|
}
|
|
|
|
if (selector) {
|
|
throw new Error("expected exactly one package selector");
|
|
}
|
|
|
|
selector = arg;
|
|
}
|
|
|
|
return {
|
|
help: false,
|
|
selector,
|
|
publish: flags.has("--publish"),
|
|
skipBuild: flags.has("--skip-build"),
|
|
otp,
|
|
};
|
|
}
|
|
|
|
function runCommand(command, args, options = {}) {
|
|
const result = spawnSync(command, args, {
|
|
cwd: repoRoot,
|
|
encoding: "utf8",
|
|
stdio: ["inherit", "pipe", "pipe"],
|
|
...options,
|
|
});
|
|
|
|
if (result.error) {
|
|
throw result.error;
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
function runChecked(command, args, options = {}) {
|
|
const result = runCommand(command, args, options);
|
|
const stdout = result.stdout ?? "";
|
|
const stderr = result.stderr ?? "";
|
|
|
|
if (stdout) process.stdout.write(stdout);
|
|
if (stderr) process.stderr.write(stderr);
|
|
|
|
if (result.status !== 0) {
|
|
throw new Error(`${command} ${args.join(" ")} failed with status ${result.status ?? "unknown"}`);
|
|
}
|
|
}
|
|
|
|
function formatCommand(command, args) {
|
|
return `${command} ${args.join(" ")}`;
|
|
}
|
|
|
|
function ensureNpmAuth() {
|
|
const result = runCommand("npm", ["whoami"]);
|
|
const stdout = result.stdout ?? "";
|
|
const stderr = result.stderr ?? "";
|
|
|
|
if (stdout) process.stdout.write(stdout);
|
|
if (stderr) process.stderr.write(stderr);
|
|
|
|
if (result.status === 0) {
|
|
return;
|
|
}
|
|
|
|
const output = `${stdout}\n${stderr}`.trim();
|
|
if (/\bE401\b|401 Unauthorized/i.test(output)) {
|
|
throw new Error(
|
|
[
|
|
"npm auth check failed.",
|
|
"This usually means the machine is either not logged into npm yet or has a stale token in ~/.npmrc.",
|
|
"Run `npm logout --registry=https://registry.npmjs.org/` and then `npm login` or `npm adduser` on this maintainer machine with an npm account that can publish to the @paperclipai scope, then rerun with --publish.",
|
|
"Do not use this auth flow in CI; it is only for the one-time human bootstrap publish.",
|
|
].join(" "),
|
|
);
|
|
}
|
|
|
|
throw new Error("npm whoami failed");
|
|
}
|
|
|
|
function inspectNpmPackage(packageName) {
|
|
const result = runCommand("npm", ["view", packageName, "version", "--json"]);
|
|
|
|
if (result.status === 0) {
|
|
const version = JSON.parse((result.stdout ?? "").trim());
|
|
return { exists: true, version };
|
|
}
|
|
|
|
const output = `${result.stdout ?? ""}\n${result.stderr ?? ""}`.trim();
|
|
if (/\bE404\b|404 Not Found|could not be found/i.test(output)) {
|
|
return { exists: false };
|
|
}
|
|
|
|
process.stderr.write(output ? `${output}\n` : "");
|
|
throw new Error(`failed to query npm for ${packageName}`);
|
|
}
|
|
|
|
function resolveTargetPackage(selector, packages = buildReleasePackagePlan()) {
|
|
const normalizedSelector = normalizePath(selector);
|
|
const matches = packages.filter(
|
|
(pkg) => pkg.name === selector || normalizePath(pkg.dir) === normalizedSelector,
|
|
);
|
|
|
|
if (matches.length === 1) {
|
|
return matches[0];
|
|
}
|
|
|
|
if (matches.length > 1) {
|
|
throw new Error(`package selector is ambiguous: ${selector}`);
|
|
}
|
|
|
|
throw new Error(
|
|
`unknown package selector: ${selector}\nKnown packages:\n- ${packages.map((pkg) => `${pkg.name} (${pkg.dir})`).join("\n- ")}`,
|
|
);
|
|
}
|
|
|
|
function printNextSteps(pkg) {
|
|
process.stdout.write(
|
|
[
|
|
"",
|
|
"Publish succeeded. Next:",
|
|
`1. Open https://www.npmjs.com/package/${pkg.name}`,
|
|
"2. Go to Settings -> Trusted publishing",
|
|
"3. Add repository paperclipai/paperclip",
|
|
"4. Set workflow filename to release.yml",
|
|
"5. Optionally enable Settings -> Publishing access -> Require two-factor authentication and disallow tokens",
|
|
"",
|
|
].join("\n"),
|
|
);
|
|
}
|
|
|
|
function buildPublishArgs(pkg, { dryRun = false, otp = null } = {}) {
|
|
const args = ["publish", pkg.dir, "--no-git-checks", "--access", "public"];
|
|
|
|
if (dryRun) {
|
|
args.push("--dry-run");
|
|
}
|
|
|
|
if (otp) {
|
|
args.push("--otp", otp);
|
|
}
|
|
|
|
return args;
|
|
}
|
|
|
|
function publishPackage(pkg, otp) {
|
|
const publishArgs = buildPublishArgs(pkg, { otp });
|
|
|
|
const result = runCommand("pnpm", publishArgs);
|
|
const stdout = result.stdout ?? "";
|
|
const stderr = result.stderr ?? "";
|
|
const output = `${stdout}\n${stderr}`.trim();
|
|
|
|
if (stdout) process.stdout.write(stdout);
|
|
if (stderr) process.stderr.write(stderr);
|
|
|
|
if (result.status === 0) {
|
|
return;
|
|
}
|
|
|
|
if (/\bEOTP\b|one-time password/i.test(output)) {
|
|
throw new Error(
|
|
[
|
|
"npm publish reached the publish-time 2FA check.",
|
|
"Complete the browser auth URL printed by npm and rerun the helper, or rerun with `--otp <code>` if your npm account uses authenticator-app codes.",
|
|
].join(" "),
|
|
);
|
|
}
|
|
|
|
throw new Error(`${formatCommand("pnpm", publishArgs)} failed with status ${result.status ?? "unknown"}`);
|
|
}
|
|
|
|
function main(argv) {
|
|
const { help, selector, publish, skipBuild, otp } = parseArgs(argv);
|
|
|
|
if (help) {
|
|
usage();
|
|
return;
|
|
}
|
|
|
|
if (!selector) {
|
|
usage();
|
|
throw new Error("missing package selector");
|
|
}
|
|
|
|
const pkg = resolveTargetPackage(selector);
|
|
process.stdout.write(`Selected ${pkg.name} (${pkg.dir})\n`);
|
|
|
|
if (publish && !otp) {
|
|
throw new Error("`--publish` requires `--otp <code>`. Generate a fresh npm one-time password and rerun.");
|
|
}
|
|
|
|
const npmState = inspectNpmPackage(pkg.name);
|
|
if (npmState.exists) {
|
|
throw new Error(`${pkg.name} already exists on npm at version ${npmState.version}; bootstrap is only for first publish`);
|
|
}
|
|
|
|
process.stdout.write(`${pkg.name} is not on npm yet; continuing with bootstrap flow.\n`);
|
|
|
|
if (publish) {
|
|
process.stdout.write("Checking npm auth with npm whoami...\n");
|
|
ensureNpmAuth();
|
|
}
|
|
|
|
if (!skipBuild && typeof pkg.pkg?.scripts?.build === "string") {
|
|
process.stdout.write(`Building ${pkg.name}...\n`);
|
|
runChecked("pnpm", ["--filter", pkg.name, "build"]);
|
|
}
|
|
|
|
process.stdout.write(`Previewing publish payload for ${pkg.name}...\n`);
|
|
runChecked("pnpm", buildPublishArgs(pkg, { dryRun: true }));
|
|
|
|
if (!publish) {
|
|
process.stdout.write(
|
|
[
|
|
"",
|
|
"Dry run complete. To perform the first publish from an authenticated maintainer machine, run:",
|
|
`node scripts/bootstrap-npm-package.mjs ${pkg.name} --publish --otp <code>`,
|
|
"",
|
|
].join("\n"),
|
|
);
|
|
return;
|
|
}
|
|
|
|
process.stdout.write(`Publishing ${pkg.name}...\n`);
|
|
publishPackage(pkg, otp);
|
|
printNextSteps(pkg);
|
|
}
|
|
|
|
const isDirectRun = process.argv[1] && resolve(process.argv[1]) === fileURLToPath(import.meta.url);
|
|
|
|
if (isDirectRun) {
|
|
try {
|
|
main(process.argv.slice(2));
|
|
} catch (error) {
|
|
process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
|
|
process.exit(1);
|
|
}
|
|
}
|
|
|
|
export {
|
|
buildPublishArgs,
|
|
ensureNpmAuth,
|
|
inspectNpmPackage,
|
|
parseArgs,
|
|
publishPackage,
|
|
resolveTargetPackage,
|
|
};
|