mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-25 02:26:12 +02:00
## Thinking Path > - Paperclip is a control plane for AI-agent companies, with the CLI acting as a scriptable operator and agent interface to that control plane. > - The REST API surface has grown across companies, agents, issues, routines, plugins, auth, workspaces, secrets, and operational inspection commands. > - The CLI had drifted from that API surface: some commands were missing, some command shapes differed from docs/reference material, and several edge cases only failed during end-to-end local-source testing. > - The local development runbook requires these tests to be disposable and isolated from a real `~/.paperclip`, `~/.codex`, or `~/.claude` installation. > - This pull request adds broad CLI/API parity coverage, fixes the actionable bugs found during that pass, and records the reproducible test log under `doc/logs`. > - The benefit is a more complete, scriptable CLI surface with regression coverage for the command families exercised by the parity run. ## What Changed - Added or expanded CLI command coverage for access/auth, companies, agents, projects, goals, issues and subresources, routines, plugins, workspaces, activity/run/cost/dashboard inspection, assets, skills, secrets, tokens, prompt/wake flows, and local setup helpers. - Fixed CLI/API parity bugs found during the run, including context profile patching, issue interaction optional payloads, malformed tree-hold errors, environment duplicate handling, configure invalid-section exit codes, worktree pnpm invocation, token agent ID resolution, plugin tool worker lookup, and routine webhook secret cleanup. - Added missing CLI wrappers and route coverage for health/access, invite resolution URL forwarding, join status normalization, secret lifecycle commands, LLM docs routes, available-skill isolation, positive board-claim coverage, and interactive `connect` prompt-flow tests. - Added a schema-backed `/api/openapi.json` route sufficient for CLI parity and `paperclipai openapi --json` smoke coverage. - Added `doc/logs/2026-05-24-cli-api-parity-e2e-log.md` with the detailed living test/bug log and renamed the log directory from `doc/bugs` to `doc/logs`. - Added `doc/plans/2026-05-23-cli-api-parity.md` and the OpenAPI parity reference used during the pass. OpenAPI note: this PR intentionally does not try to subsume `feature/openapi-spec`. The OpenAPI implementation here is schema-backed and better than the earlier route-inventory stub, but `feature/openapi-spec` is the fuller/better OpenAPI branch because it includes exact mounted-route coverage tests and additional current route coverage. That branch should stay as its own PR and can supersede this OpenAPI route implementation. ## Verification Targeted automated checks run: - `pnpm exec vitest run server/src/__tests__/openapi-routes.test.ts` - `pnpm exec vitest run server/src/__tests__/board-claim.test.ts` - `pnpm exec vitest run cli/src/__tests__/connect.test.ts` - `pnpm exec vitest run cli/src/__tests__/agent-lifecycle.test.ts` - `pnpm exec vitest run server/src/__tests__/plugin-database.test.ts` - `pnpm exec vitest run server/src/__tests__/routines-service.test.ts` - `pnpm --dir cli typecheck` - `pnpm --dir server typecheck` Manual/local E2E verification: - Ran the full disposable local-source CLI/API parity pass with isolated `PAPERCLIP_HOME`, `PAPERCLIP_CONFIG`, `PAPERCLIP_CONTEXT`, `PAPERCLIP_AUTH_STORE`, `CODEX_HOME`, and `CLAUDE_HOME` under `tmp/cli-api-parity`. - Verified `DATABASE_URL` and `DATABASE_MIGRATION_URL` stayed unset for the scratch server. - Verified live health and schema-backed OpenAPI responses on non-default port `3197`. - Revoked created board/agent tokens and cleaned up temporary plugins, secrets, non-default environments, and project workspaces. - See `doc/logs/2026-05-24-cli-api-parity-e2e-log.md` for the full command-by-command reproduction log. Not run: - Full `pnpm test`, `pnpm test:run`, or `pnpm build` were not run after the entire branch because the branch is broad and the parity pass used focused test/typecheck verification plus live isolated CLI reruns. ## Risks - This is a broad PR and touches many CLI command modules, so review surface is high. The changes are grouped around one theme, but a split may be easier if maintainers prefer narrower PRs. - The OpenAPI route in this PR is not the final/best OpenAPI implementation. `feature/openapi-spec` has stronger exact-route coverage and should remain the source for the dedicated OpenAPI PR. - The living log is intentionally detailed and large. It is useful for reproducibility but adds documentation weight. - No UI changes are intended; screenshots are not applicable. > 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-based coding agent in Codex desktop. Exact served model/context-window identifier was not exposed in the local app. Work used shell/Git/GitHub CLI tooling, local source inspection, targeted test execution, and live isolated Paperclip CLI/API smoke testing. ## 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Devin Foley <devin@devinfoley.com>
118 lines
5.9 KiB
TypeScript
118 lines
5.9 KiB
TypeScript
import { Command } from "commander";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { registerAgentCommands } from "../commands/client/agent.js";
|
|
|
|
const COMPANY_ID = "22222222-2222-4222-8222-222222222222";
|
|
const AGENT_ID = "11111111-1111-4111-8111-111111111111";
|
|
const REVISION_ID = "33333333-3333-4333-8333-333333333333";
|
|
|
|
function createProgram(): Command {
|
|
const program = new Command();
|
|
program.exitOverride();
|
|
program.configureOutput({
|
|
writeOut: () => {},
|
|
writeErr: () => {},
|
|
});
|
|
registerAgentCommands(program);
|
|
return program;
|
|
}
|
|
|
|
async function run(args: string[]): Promise<void> {
|
|
await createProgram().parseAsync([
|
|
...args,
|
|
"--api-base", "http://localhost:3100",
|
|
"--api-key", "board-token",
|
|
], { from: "user" });
|
|
}
|
|
|
|
describe("agent lifecycle commands", () => {
|
|
beforeEach(() => {
|
|
vi.restoreAllMocks();
|
|
delete process.env.PAPERCLIP_API_KEY;
|
|
delete process.env.PAPERCLIP_API_URL;
|
|
vi.spyOn(console, "log").mockImplementation(() => {});
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it("wraps agent lifecycle and state endpoints", async () => {
|
|
const fetchMock = vi.fn().mockImplementation(() => Promise.resolve(jsonResponse()));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await run([
|
|
"agent", "create",
|
|
"--company-id", COMPANY_ID,
|
|
"--payload-json", JSON.stringify({ name: "Builder", adapterType: "codex_local" }),
|
|
]);
|
|
await run(["agent", "hire", "--company-id", COMPANY_ID, "--payload-json", "{}"]);
|
|
await run(["agent", "update", AGENT_ID, "--payload-json", JSON.stringify({ title: "Senior Builder" })]);
|
|
await run(["agent", "pause", AGENT_ID]);
|
|
await run(["agent", "resume", AGENT_ID]);
|
|
await run(["agent", "approve", AGENT_ID]);
|
|
await run(["agent", "terminate", AGENT_ID]);
|
|
await run(["agent", "heartbeat:invoke", AGENT_ID]);
|
|
await run(["agent", "claude-login", AGENT_ID]);
|
|
await run(["agent", "delete", AGENT_ID, "--yes"]);
|
|
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", call[0]])).toEqual([
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/agents`],
|
|
["POST", `http://localhost:3100/api/companies/${COMPANY_ID}/agent-hires`],
|
|
["PATCH", `http://localhost:3100/api/agents/${AGENT_ID}`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/pause`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/resume`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/approve`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/terminate`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/heartbeat/invoke`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/claude-login`],
|
|
["DELETE", `http://localhost:3100/api/agents/${AGENT_ID}`],
|
|
]);
|
|
});
|
|
|
|
it("wraps configuration, runtime, skills, and instructions endpoints", async () => {
|
|
const fetchMock = vi.fn().mockImplementation(() => Promise.resolve(jsonResponse()));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
await run(["agent", "permissions:update", AGENT_ID, "--payload-json", JSON.stringify({ canCreateAgents: true, canAssignTasks: true })]);
|
|
await run(["agent", "configuration", AGENT_ID]);
|
|
await run(["agent", "config-revisions", AGENT_ID]);
|
|
await run(["agent", "config-revision:get", AGENT_ID, REVISION_ID]);
|
|
await run(["agent", "config-revision:rollback", AGENT_ID, REVISION_ID]);
|
|
await run(["agent", "runtime-state", AGENT_ID]);
|
|
await run(["agent", "runtime-state:reset-session", AGENT_ID, "--task-key", "task-1"]);
|
|
await run(["agent", "task-sessions", AGENT_ID]);
|
|
await run(["agent", "skills", AGENT_ID]);
|
|
await run(["agent", "skills:sync", AGENT_ID, "--desired-skills", "paperclip,github"]);
|
|
await run(["agent", "instructions-path:update", AGENT_ID, "--payload-json", JSON.stringify({ path: "/tmp/AGENTS.md" })]);
|
|
await run(["agent", "instructions-bundle", AGENT_ID]);
|
|
await run(["agent", "instructions-bundle:update", AGENT_ID, "--payload-json", JSON.stringify({ mode: "managed" })]);
|
|
await run(["agent", "instructions-file:get", AGENT_ID, "--path", "AGENTS.md"]);
|
|
await run(["agent", "instructions-file:put", AGENT_ID, "--path", "AGENTS.md", "--content", "hello"]);
|
|
await run(["agent", "instructions-file:delete", AGENT_ID, "--path", "AGENTS.md"]);
|
|
|
|
expect(fetchMock.mock.calls.map((call) => [call[1]?.method ?? "GET", call[0]])).toEqual([
|
|
["PATCH", `http://localhost:3100/api/agents/${AGENT_ID}/permissions`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/configuration`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/config-revisions`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/config-revisions/${REVISION_ID}`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/config-revisions/${REVISION_ID}/rollback`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/runtime-state`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/runtime-state/reset-session`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/task-sessions`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/skills`],
|
|
["POST", `http://localhost:3100/api/agents/${AGENT_ID}/skills/sync`],
|
|
["PATCH", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-path`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle`],
|
|
["PATCH", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle`],
|
|
["GET", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle/file?path=AGENTS.md`],
|
|
["PUT", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle/file`],
|
|
["DELETE", `http://localhost:3100/api/agents/${AGENT_ID}/instructions-bundle/file?path=AGENTS.md`],
|
|
]);
|
|
});
|
|
});
|
|
|
|
function jsonResponse(body: unknown = { ok: true }, init: ResponseInit = { status: 200 }): Response {
|
|
return new Response(JSON.stringify(body), init);
|
|
}
|