mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-23 17:33:51 +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>
261 lines
8.7 KiB
TypeScript
261 lines
8.7 KiB
TypeScript
import { Command } from "commander";
|
|
import {
|
|
createApprovalSchema,
|
|
requestApprovalRevisionSchema,
|
|
resolveApprovalSchema,
|
|
resubmitApprovalSchema,
|
|
type Approval,
|
|
type ApprovalComment,
|
|
} from "@paperclipai/shared";
|
|
import {
|
|
addCommonClientOptions,
|
|
apiPath,
|
|
formatInlineRecord,
|
|
handleCommandError,
|
|
printOutput,
|
|
resolveCommandContext,
|
|
type BaseClientOptions,
|
|
} from "./common.js";
|
|
|
|
interface ApprovalListOptions extends BaseClientOptions {
|
|
companyId?: string;
|
|
status?: string;
|
|
}
|
|
|
|
interface ApprovalDecisionOptions extends BaseClientOptions {
|
|
decisionNote?: string;
|
|
decidedByUserId?: string;
|
|
}
|
|
|
|
interface ApprovalCreateOptions extends BaseClientOptions {
|
|
companyId?: string;
|
|
type: string;
|
|
requestedByAgentId?: string;
|
|
payload: string;
|
|
issueIds?: string;
|
|
}
|
|
|
|
interface ApprovalResubmitOptions extends BaseClientOptions {
|
|
payload?: string;
|
|
}
|
|
|
|
interface ApprovalCommentOptions extends BaseClientOptions {
|
|
body: string;
|
|
}
|
|
|
|
export function registerApprovalCommands(program: Command): void {
|
|
const approval = program.command("approval").description("Approval operations");
|
|
|
|
addCommonClientOptions(
|
|
approval
|
|
.command("list")
|
|
.description("List approvals for a company")
|
|
.requiredOption("-C, --company-id <id>", "Company ID")
|
|
.option("--status <status>", "Status filter")
|
|
.action(async (opts: ApprovalListOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts, { requireCompany: true });
|
|
const params = new URLSearchParams();
|
|
if (opts.status) params.set("status", opts.status);
|
|
const query = params.toString();
|
|
const rows =
|
|
(await ctx.api.get<Approval[]>(
|
|
`${apiPath`/api/companies/${ctx.companyId}/approvals`}${query ? `?${query}` : ""}`,
|
|
)) ?? [];
|
|
|
|
if (ctx.json) {
|
|
printOutput(rows, { json: true });
|
|
return;
|
|
}
|
|
|
|
if (rows.length === 0) {
|
|
printOutput([], { json: false });
|
|
return;
|
|
}
|
|
|
|
for (const row of rows) {
|
|
console.log(
|
|
formatInlineRecord({
|
|
id: row.id,
|
|
type: row.type,
|
|
status: row.status,
|
|
requestedByAgentId: row.requestedByAgentId,
|
|
requestedByUserId: row.requestedByUserId,
|
|
}),
|
|
);
|
|
}
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
{ includeCompany: false },
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
approval
|
|
.command("get")
|
|
.description("Get one approval")
|
|
.argument("<approvalId>", "Approval ID")
|
|
.action(async (approvalId: string, opts: BaseClientOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts);
|
|
const row = await ctx.api.get<Approval>(apiPath`/api/approvals/${approvalId}`);
|
|
printOutput(row, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
approval
|
|
.command("create")
|
|
.description("Create an approval request")
|
|
.requiredOption("-C, --company-id <id>", "Company ID")
|
|
.requiredOption("--type <type>", "Approval type (hire_agent|approve_ceo_strategy)")
|
|
.requiredOption("--payload <json>", "Approval payload as JSON object")
|
|
.option("--requested-by-agent-id <id>", "Requesting agent ID")
|
|
.option("--issue-ids <csv>", "Comma-separated linked issue IDs")
|
|
.action(async (opts: ApprovalCreateOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts, { requireCompany: true });
|
|
const payloadJson = parseJsonObject(opts.payload, "payload");
|
|
const payload = createApprovalSchema.parse({
|
|
type: opts.type,
|
|
payload: payloadJson,
|
|
requestedByAgentId: opts.requestedByAgentId,
|
|
issueIds: parseCsv(opts.issueIds),
|
|
});
|
|
const created = await ctx.api.post<Approval>(apiPath`/api/companies/${ctx.companyId}/approvals`, payload);
|
|
printOutput(created, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
{ includeCompany: false },
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
approval
|
|
.command("approve")
|
|
.description("Approve an approval request")
|
|
.argument("<approvalId>", "Approval ID")
|
|
.option("--decision-note <text>", "Decision note")
|
|
.option("--decided-by-user-id <id>", "Decision actor user ID")
|
|
.action(async (approvalId: string, opts: ApprovalDecisionOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts);
|
|
const payload = resolveApprovalSchema.parse({
|
|
decisionNote: opts.decisionNote,
|
|
decidedByUserId: opts.decidedByUserId,
|
|
});
|
|
const updated = await ctx.api.post<Approval>(apiPath`/api/approvals/${approvalId}/approve`, payload);
|
|
printOutput(updated, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
approval
|
|
.command("reject")
|
|
.description("Reject an approval request")
|
|
.argument("<approvalId>", "Approval ID")
|
|
.option("--decision-note <text>", "Decision note")
|
|
.option("--decided-by-user-id <id>", "Decision actor user ID")
|
|
.action(async (approvalId: string, opts: ApprovalDecisionOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts);
|
|
const payload = resolveApprovalSchema.parse({
|
|
decisionNote: opts.decisionNote,
|
|
decidedByUserId: opts.decidedByUserId,
|
|
});
|
|
const updated = await ctx.api.post<Approval>(apiPath`/api/approvals/${approvalId}/reject`, payload);
|
|
printOutput(updated, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
approval
|
|
.command("request-revision")
|
|
.description("Request revision for an approval")
|
|
.argument("<approvalId>", "Approval ID")
|
|
.option("--decision-note <text>", "Decision note")
|
|
.option("--decided-by-user-id <id>", "Decision actor user ID")
|
|
.action(async (approvalId: string, opts: ApprovalDecisionOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts);
|
|
const payload = requestApprovalRevisionSchema.parse({
|
|
decisionNote: opts.decisionNote,
|
|
decidedByUserId: opts.decidedByUserId,
|
|
});
|
|
const updated = await ctx.api.post<Approval>(apiPath`/api/approvals/${approvalId}/request-revision`, payload);
|
|
printOutput(updated, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
approval
|
|
.command("resubmit")
|
|
.description("Resubmit an approval (optionally with new payload)")
|
|
.argument("<approvalId>", "Approval ID")
|
|
.option("--payload <json>", "Payload JSON object")
|
|
.action(async (approvalId: string, opts: ApprovalResubmitOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts);
|
|
const payload = resubmitApprovalSchema.parse({
|
|
payload: opts.payload ? parseJsonObject(opts.payload, "payload") : undefined,
|
|
});
|
|
const updated = await ctx.api.post<Approval>(apiPath`/api/approvals/${approvalId}/resubmit`, payload);
|
|
printOutput(updated, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
approval
|
|
.command("comment")
|
|
.description("Add comment to an approval")
|
|
.argument("<approvalId>", "Approval ID")
|
|
.requiredOption("--body <text>", "Comment body")
|
|
.action(async (approvalId: string, opts: ApprovalCommentOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts);
|
|
const created = await ctx.api.post<ApprovalComment>(apiPath`/api/approvals/${approvalId}/comments`, {
|
|
body: opts.body,
|
|
});
|
|
printOutput(created, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
);
|
|
}
|
|
|
|
function parseCsv(value: string | undefined): string[] | undefined {
|
|
if (!value) return undefined;
|
|
const rows = value.split(",").map((v) => v.trim()).filter(Boolean);
|
|
return rows.length > 0 ? rows : undefined;
|
|
}
|
|
|
|
function parseJsonObject(value: string, name: string): Record<string, unknown> {
|
|
try {
|
|
const parsed = JSON.parse(value) as unknown;
|
|
if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) {
|
|
throw new Error(`${name} must be a JSON object`);
|
|
}
|
|
return parsed as Record<string, unknown>;
|
|
} catch (err) {
|
|
throw new Error(`Invalid ${name} JSON: ${err instanceof Error ? err.message : String(err)}`);
|
|
}
|
|
}
|