mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-06 21:05:21 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agent adapters are the boundary between the control plane and the runtimes that actually do work. > - Hermes support needs to be available as first-class local and gateway adapters while still preserving the adapter-manager override path for external packages. > - The adapter work touches runtime execution, UI adapter metadata, onboarding prompts, scoped credentials, release packaging, and smoke coverage, so the handoff needs concrete verification rather than only unit tests. > - This pull request adds built-in Hermes local and Hermes gateway support, keeps external adapter overrides compatible, and documents/tests the gateway flow end to end. > - The benefit is that operators can hire Hermes-backed agents without a manual plugin install, while self-hosted installs can still override/shadow the built-ins through Adapter manager packages. ## Linked Issues or Issue Description No public GitHub issue exists for this exact Hermes built-in adapter, gateway onboarding, and release-source work. Problem description: - Hermes local and gateway adapters need a public, reviewable source path in the monorepo so package artifacts and built-in adapter behavior match the application source. - Operators need built-in `hermes_local` and `hermes_gateway` adapter choices without losing the ability to install external Hermes packages as overrides. - Gateway onboarding needs secure defaults for API server URLs, API keys, and generated agent setup text. - Hermes-originated task bridge credentials need narrower API-key scope configuration. - Related public PRs found during duplicate search include #3027, #2363, #7544, #7950, #8095, and #8543. ## What Changed - Added the unified Hermes adapter package with local and gateway server/UI/CLI exports, config schemas, transcript parsing, model detection, and package metadata. - Registered `hermes_local` and `hermes_gateway` as built-in adapters across shared constants, server registries, CLI packaging, and UI adapter registries. - Kept the external adapter override path compatible so installed Hermes packages can shadow built-ins and restore the built-in parser when disabled. - Added Hermes gateway onboarding docs, board-operator docs, Docker smoke assets, and shell smoke harnesses for join/e2e validation. - Added scoped task-bridge API-key support, authorization checks, issue-origin handling, and tests for Hermes-created Paperclip tasks. - Hardened gateway transport and redaction behavior for API keys, headers, session data, and smoke diagnostics. - Updated release packaging/bootstrap checks for the Hermes packages while leaving `pnpm-lock.yaml` out of the PR per repository policy. ## Verification Targeted local verification recorded before PR handoff: - `pnpm --filter @paperclipai/hermes-paperclip-adapter exec vitest run src/gateway/server/execute.test.ts` — 14/14 passed. - `pnpm test:hermes-gateway-smoke` — 6/6 passed. - Hermes package typecheck/build checks passed. - Focused server/UI adapter tests passed — 31/31. - Release helper Node tests passed — 18/18. - `git diff --check origin/master..HEAD` passed. Fresh Docker E2E smoke evidence: - Ran `pnpm smoke:hermes-gateway-e2e` on 2026-06-26 with a fresh state directory and fresh Docker container against a live Paperclip dev server. - Hermes direct execution reached `completed`. - Hermes stop/cancel path reached `cancelled`. - Hermes gateway created a Paperclip task, Paperclip ran the Hermes agent, and the task reached `done` with the expected marker response. - Temporary board auth keys, token files, smoke state, and Docker containers were cleaned up after the run. PR checks on head `b5eae40ce`: - GitHub Actions passed: `policy`, `review`, `Typecheck + Release Registry`, all general test shards, all serialized server shards, `Build`, `Canary Dry Run`, `e2e`, and aggregate `verify`. - External checks passed: Snyk and Socket Project Report. - External Socket Pull Request Alerts remained pending after the first-party CI matrix completed. ## Risks - Medium risk: this spans adapter registration, package publishing, gateway execution, onboarding docs, API-key scoping, and UI adapter metadata. - Migration risk is low: the scope-config migration adds a nullable column and does not rewrite existing keys. - Gateway execution depends on operator-provided Hermes API configuration; the smoke covers the Docker gateway path but real deployments may differ by network/auth setup. - Direct Greptile review on the latest expanded diff is file-count limited, although the commitperclip review gate passed. > 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 Codex, GPT-5 coding agent, tool use enabled in a local repository workspace. Context window size is not exposed in this environment. ## 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] Commitperclip review gate is green; direct Greptile review is file-count limited on the latest expanded diff - [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/adapter-acpx-local",
|
|
" node scripts/bootstrap-npm-package.mjs packages/adapters/acpx-local --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,
|
|
};
|