mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 08:22:20 +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>
148 lines
4.9 KiB
TypeScript
148 lines
4.9 KiB
TypeScript
import { readFile, writeFile } from "node:fs/promises";
|
|
import { Command } from "commander";
|
|
import { ApiRequestError } from "../../client/http.js";
|
|
import {
|
|
addCommonClientOptions,
|
|
apiPath,
|
|
handleCommandError,
|
|
inferContentTypeFromPath,
|
|
printOutput,
|
|
resolveCommandContext,
|
|
type BaseClientOptions,
|
|
} from "./common.js";
|
|
|
|
interface AssetOptions extends BaseClientOptions {
|
|
companyId?: string;
|
|
file?: string;
|
|
namespace?: string;
|
|
alt?: string;
|
|
title?: string;
|
|
out?: string;
|
|
}
|
|
|
|
export function registerAssetCommands(program: Command): void {
|
|
const asset = program.command("asset").description("Asset operations");
|
|
|
|
addCommonClientOptions(
|
|
asset
|
|
.command("image:upload")
|
|
.description("Upload a company image asset")
|
|
.requiredOption("--file <path>", "Image file path")
|
|
.option("-C, --company-id <id>", "Company ID")
|
|
.option("--namespace <value>", "Asset namespace suffix")
|
|
.option("--alt <text>", "Alt text metadata")
|
|
.option("--title <text>", "Title metadata")
|
|
.action(async (opts: AssetOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts, { requireCompany: true });
|
|
const result = await uploadAsset(ctx.api.apiBase, ctx.api.apiKey, apiPath`/api/companies/${ctx.companyId}/assets/images`, opts);
|
|
printOutput(result, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
{ includeCompany: false },
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
asset
|
|
.command("logo:upload")
|
|
.description("Upload a company logo")
|
|
.requiredOption("--file <path>", "Logo file path")
|
|
.option("-C, --company-id <id>", "Company ID")
|
|
.action(async (opts: AssetOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts, { requireCompany: true });
|
|
const result = await uploadAsset(ctx.api.apiBase, ctx.api.apiKey, apiPath`/api/companies/${ctx.companyId}/logo`, opts);
|
|
printOutput(result, { json: ctx.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
{ includeCompany: false },
|
|
);
|
|
|
|
addCommonClientOptions(
|
|
asset
|
|
.command("content")
|
|
.description("Download asset content")
|
|
.argument("<assetId>", "Asset ID")
|
|
.option("--out <path>", "Write content to a file instead of stdout")
|
|
.action(async (assetId: string, opts: AssetOptions) => {
|
|
try {
|
|
const ctx = resolveCommandContext(opts);
|
|
const bytes = await downloadAsset(ctx.api.apiBase, ctx.api.apiKey, assetId);
|
|
if (opts.out?.trim()) {
|
|
await writeFile(opts.out, bytes);
|
|
printOutput({ ok: true, out: opts.out, bytes: bytes.length }, { json: ctx.json });
|
|
return;
|
|
}
|
|
process.stdout.write(bytes);
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
);
|
|
}
|
|
|
|
async function uploadAsset(
|
|
apiBase: string,
|
|
apiKey: string | undefined,
|
|
path: string,
|
|
opts: AssetOptions,
|
|
): Promise<unknown> {
|
|
if (!opts.file?.trim()) {
|
|
throw new Error("--file is required");
|
|
}
|
|
const bytes = await readFile(opts.file);
|
|
const form = new FormData();
|
|
form.set("file", new Blob([bytes], { type: inferContentTypeFromPath(opts.file) }), opts.file.split(/[\\/]/).pop() ?? "asset");
|
|
if (opts.namespace?.trim()) form.set("namespace", opts.namespace.trim());
|
|
if (opts.alt?.trim()) form.set("alt", opts.alt.trim());
|
|
if (opts.title?.trim()) form.set("title", opts.title.trim());
|
|
|
|
const response = await fetch(buildApiUrl(apiBase, path), {
|
|
method: "POST",
|
|
headers: apiKey ? { authorization: `Bearer ${apiKey}` } : undefined,
|
|
body: form,
|
|
});
|
|
return parseFetchResponse(response);
|
|
}
|
|
|
|
async function downloadAsset(apiBase: string, apiKey: string | undefined, assetId: string): Promise<Buffer> {
|
|
const response = await fetch(buildApiUrl(apiBase, apiPath`/api/assets/${assetId}/content`), {
|
|
headers: apiKey ? { authorization: `Bearer ${apiKey}` } : undefined,
|
|
});
|
|
if (!response.ok) {
|
|
await parseFetchResponse(response);
|
|
}
|
|
return Buffer.from(await response.arrayBuffer());
|
|
}
|
|
|
|
async function parseFetchResponse(response: Response): Promise<unknown> {
|
|
const text = await response.text();
|
|
const parsed = text.trim() ? safeJson(text) : null;
|
|
if (!response.ok) {
|
|
const message =
|
|
typeof parsed === "object" && parsed !== null && "error" in parsed && typeof parsed.error === "string"
|
|
? parsed.error
|
|
: `Request failed with status ${response.status}`;
|
|
throw new ApiRequestError(response.status, message, undefined, parsed);
|
|
}
|
|
return parsed;
|
|
}
|
|
|
|
function buildApiUrl(apiBase: string, path: string): string {
|
|
const url = new URL(apiBase);
|
|
url.pathname = `${url.pathname.replace(/\/+$/, "")}${path.startsWith("/") ? path : `/${path}`}`;
|
|
return url.toString();
|
|
}
|
|
|
|
function safeJson(text: string): unknown {
|
|
try {
|
|
return JSON.parse(text);
|
|
} catch {
|
|
return text;
|
|
}
|
|
}
|