mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-11 14:10:50 +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>
229 lines
8.5 KiB
TypeScript
229 lines
8.5 KiB
TypeScript
import { Command } from "commander";
|
|
import type { Project } from "@paperclipai/shared";
|
|
import { createProjectSchema, updateProjectSchema } from "@paperclipai/shared";
|
|
import {
|
|
addCommonClientOptions,
|
|
apiPath,
|
|
formatInlineRecord,
|
|
handleCommandError,
|
|
printOutput,
|
|
resolveCommandContext,
|
|
type BaseClientOptions,
|
|
} from "./common.js";
|
|
|
|
interface ProjectListOptions extends BaseClientOptions {
|
|
companyId?: string;
|
|
}
|
|
|
|
interface ProjectCreateOptions extends BaseClientOptions {
|
|
companyId?: string;
|
|
name: string;
|
|
description?: string;
|
|
status?: string;
|
|
goalId?: string;
|
|
goalIds?: string;
|
|
leadAgentId?: string;
|
|
targetDate?: string;
|
|
color?: string;
|
|
envJson?: string;
|
|
executionWorkspacePolicyJson?: string;
|
|
}
|
|
|
|
interface ProjectUpdateOptions extends BaseClientOptions {
|
|
name?: string;
|
|
description?: string;
|
|
status?: string;
|
|
goalId?: string;
|
|
goalIds?: string;
|
|
leadAgentId?: string;
|
|
targetDate?: string;
|
|
color?: string;
|
|
envJson?: string;
|
|
executionWorkspacePolicyJson?: string;
|
|
archivedAt?: string;
|
|
}
|
|
|
|
interface ProjectDeleteOptions extends BaseClientOptions {
|
|
yes?: boolean;
|
|
}
|
|
|
|
export function registerProjectCommands(program: Command): void {
|
|
const project = program.command("project").description("Project operations");
|
|
|
|
addCommonClientOptions(
|
|
project
|
|
.command("list")
|
|
.description("List projects for a company")
|
|
.option("-C, --company-id <id>", "Company ID")
|
|
.action(async (opts: ProjectListOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts, { requireCompany: true });
|
|
const rows = (await ctx.api.get<Project[]>(apiPath`/api/companies/${ctx.companyId}/projects`)) ?? [];
|
|
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,
|
|
name: row.name,
|
|
status: row.status,
|
|
urlKey: row.urlKey,
|
|
goalIds: row.goalIds?.join(",") ?? "",
|
|
leadAgentId: row.leadAgentId,
|
|
}));
|
|
}
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
{ includeCompany: false },
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
project
|
|
.command("get")
|
|
.description("Get one project by ID or shortname")
|
|
.argument("<project>", "Project ID or shortname")
|
|
.option("-C, --company-id <id>", "Company ID for shortname lookup")
|
|
.action(async (projectRef: string, opts: ProjectListOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts);
|
|
const query = ctx.companyId ? `?${new URLSearchParams({ companyId: ctx.companyId }).toString()}` : "";
|
|
const row = await ctx.api.get<Project>(`${apiPath`/api/projects/${projectRef}`}${query}`);
|
|
printOutput(row, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
{ includeCompany: false },
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
project
|
|
.command("create")
|
|
.description("Create a project")
|
|
.requiredOption("-C, --company-id <id>", "Company ID")
|
|
.requiredOption("--name <name>", "Project name")
|
|
.option("--description <text>", "Project description")
|
|
.option("--status <status>", "Project status")
|
|
.option("--goal-id <id>", "Deprecated single goal ID")
|
|
.option("--goal-ids <csv>", "Comma-separated goal IDs")
|
|
.option("--lead-agent-id <id>", "Lead agent ID")
|
|
.option("--target-date <date>", "Target date")
|
|
.option("--color <value>", "Project color")
|
|
.option("--env-json <json>", "Project env binding JSON")
|
|
.option("--execution-workspace-policy-json <json>", "Execution workspace policy JSON")
|
|
.action(async (opts: ProjectCreateOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts, { requireCompany: true });
|
|
const payload = createProjectSchema.parse({
|
|
name: opts.name,
|
|
description: opts.description,
|
|
status: opts.status,
|
|
goalId: parseNullableString(opts.goalId),
|
|
goalIds: parseCsv(opts.goalIds),
|
|
leadAgentId: parseNullableString(opts.leadAgentId),
|
|
targetDate: parseNullableString(opts.targetDate),
|
|
color: parseNullableString(opts.color),
|
|
env: parseOptionalJson(opts.envJson),
|
|
executionWorkspacePolicy: parseOptionalJson(opts.executionWorkspacePolicyJson),
|
|
});
|
|
const created = await ctx.api.post<Project>(apiPath`/api/companies/${ctx.companyId}/projects`, payload);
|
|
printOutput(created, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
{ includeCompany: false },
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
project
|
|
.command("update")
|
|
.description("Update a project")
|
|
.argument("<project>", "Project ID or shortname")
|
|
.option("-C, --company-id <id>", "Company ID for shortname lookup")
|
|
.option("--name <name>", "Project name")
|
|
.option("--description <text|null>", "Project description")
|
|
.option("--status <status>", "Project status")
|
|
.option("--goal-id <id|null>", "Deprecated single goal ID")
|
|
.option("--goal-ids <csv>", "Comma-separated goal IDs")
|
|
.option("--lead-agent-id <id|null>", "Lead agent ID")
|
|
.option("--target-date <date|null>", "Target date")
|
|
.option("--color <value|null>", "Project color")
|
|
.option("--env-json <json|null>", "Project env binding JSON")
|
|
.option("--execution-workspace-policy-json <json|null>", "Execution workspace policy JSON")
|
|
.option("--archived-at <iso8601|null>", "Archive timestamp or null")
|
|
.action(async (projectRef: string, opts: ProjectUpdateOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts);
|
|
const payload = updateProjectSchema.parse({
|
|
name: opts.name,
|
|
description: parseNullableString(opts.description),
|
|
status: opts.status,
|
|
goalId: parseNullableString(opts.goalId),
|
|
goalIds: opts.goalIds === undefined ? undefined : parseCsv(opts.goalIds),
|
|
leadAgentId: parseNullableString(opts.leadAgentId),
|
|
targetDate: parseNullableString(opts.targetDate),
|
|
color: parseNullableString(opts.color),
|
|
env: parseOptionalJson(opts.envJson),
|
|
executionWorkspacePolicy: parseOptionalJson(opts.executionWorkspacePolicyJson),
|
|
archivedAt: parseNullableString(opts.archivedAt),
|
|
});
|
|
const query = ctx.companyId ? `?${new URLSearchParams({ companyId: ctx.companyId }).toString()}` : "";
|
|
const updated = await ctx.api.patch<Project>(`${apiPath`/api/projects/${projectRef}`}${query}`, payload);
|
|
printOutput(updated, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
{ includeCompany: false },
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
project
|
|
.command("delete")
|
|
.description("Delete a project")
|
|
.argument("<project>", "Project ID or shortname")
|
|
.option("-C, --company-id <id>", "Company ID for shortname lookup")
|
|
.option("--yes", "Confirm deletion")
|
|
.action(async (projectRef: string, opts: ProjectDeleteOptions) => {
|
|
try {
|
|
if (!opts.yes) throw new Error("Deletion requires --yes.");
|
|
const ctx = resolveCommandContext(opts);
|
|
const query = ctx.companyId ? `?${new URLSearchParams({ companyId: ctx.companyId }).toString()}` : "";
|
|
const deleted = await ctx.api.delete<Project>(`${apiPath`/api/projects/${projectRef}`}${query}`);
|
|
printOutput(deleted, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
{ includeCompany: false },
|
|
);
|
|
}
|
|
|
|
function parseCsv(value: string | undefined): string[] | undefined {
|
|
if (value === undefined) return undefined;
|
|
return value.split(",").map((part) => part.trim()).filter(Boolean);
|
|
}
|
|
|
|
function parseNullableString(value: string | undefined): string | null | undefined {
|
|
if (value === undefined) return undefined;
|
|
return value.trim().toLowerCase() === "null" ? null : value;
|
|
}
|
|
|
|
function parseOptionalJson(value: string | undefined): unknown {
|
|
if (value === undefined) return undefined;
|
|
if (value.trim().toLowerCase() === "null") return null;
|
|
try {
|
|
return JSON.parse(value);
|
|
} catch (err) {
|
|
throw new Error(`Invalid JSON: ${err instanceof Error ? err.message : String(err)}`);
|
|
}
|
|
}
|