mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-16 15:15:35 +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>
266 lines
9.1 KiB
TypeScript
266 lines
9.1 KiB
TypeScript
import { Command } from "commander";
|
|
import * as p from "@clack/prompts";
|
|
import pc from "picocolors";
|
|
import type { Agent, Company } from "@paperclipai/shared";
|
|
import { createAgentKeySchema, createBoardApiKeySchema } from "@paperclipai/shared";
|
|
import { loginBoardCli } from "../../client/board-auth.js";
|
|
import { PaperclipApiClient } from "../../client/http.js";
|
|
import { resolveProfile, readContext, setCurrentProfile, upsertProfile } from "../../client/context.js";
|
|
import {
|
|
addCommonClientOptions,
|
|
apiPath,
|
|
handleCommandError,
|
|
normalizeApiBase,
|
|
printOutput,
|
|
resolveApiBase,
|
|
type BaseClientOptions,
|
|
} from "./common.js";
|
|
|
|
interface ConnectOptions extends BaseClientOptions {
|
|
profile?: string;
|
|
persona?: "board" | "agent";
|
|
apiKeyEnvVarName?: string;
|
|
tokenName?: string;
|
|
}
|
|
|
|
interface CreatedAgentKey {
|
|
id: string;
|
|
name: string;
|
|
token: string;
|
|
createdAt: string;
|
|
}
|
|
|
|
interface CreatedBoardKey extends CreatedAgentKey {
|
|
expiresAt: string | null;
|
|
}
|
|
|
|
export function registerConnectCommand(program: Command): void {
|
|
addCommonClientOptions(
|
|
program
|
|
.command("connect")
|
|
.description("Interactively connect the CLI as a board operator or agent")
|
|
.option("--persona <persona>", "Persona to configure: board or agent")
|
|
.option("--api-key-env-var-name <name>", "Env var name to store in the profile", "PAPERCLIP_API_KEY")
|
|
.option("--token-name <name>", "Token label to create")
|
|
.action(async (opts: ConnectOptions) => {
|
|
try {
|
|
const result = await connectWizard(opts);
|
|
printOutput(result, { json: opts.json });
|
|
} catch (err) {
|
|
handleCommandError(err);
|
|
}
|
|
}),
|
|
);
|
|
}
|
|
|
|
async function connectWizard(opts: ConnectOptions) {
|
|
if (!process.stdin.isTTY || !process.stdout.isTTY) {
|
|
throw new Error("`paperclipai connect` is interactive. For scripts, pass --api-base/--api-key or use context set/token commands.");
|
|
}
|
|
|
|
p.intro(pc.bgCyan(pc.black(" paperclipai connect ")));
|
|
|
|
const context = readContext(opts.context);
|
|
const resolvedProfile = resolveProfile(context, opts.profile);
|
|
const initialApiBase = resolveApiBase(opts, resolvedProfile.profile);
|
|
const apiBaseInput = await p.text({
|
|
message: "Paperclip API base",
|
|
initialValue: initialApiBase,
|
|
placeholder: "http://localhost:3100",
|
|
});
|
|
assertNotCancelled(apiBaseInput);
|
|
const apiBase = normalizeApiBase(String(apiBaseInput || initialApiBase));
|
|
console.log(pc.dim(`Checking ${apiBase}/api/health ...`));
|
|
await verifyHealth(apiBase);
|
|
|
|
const boardLogin = await loginBoardCli({
|
|
apiBase,
|
|
requestedAccess: "board",
|
|
requestedCompanyId: opts.companyId ?? resolvedProfile.profile.companyId ?? null,
|
|
command: "paperclipai connect",
|
|
});
|
|
const boardApi = new PaperclipApiClient({ apiBase, apiKey: boardLogin.token });
|
|
const companies = (await boardApi.get<Company[]>("/api/companies")) ?? [];
|
|
|
|
const persona = await choosePersona(opts.persona);
|
|
const profileName = opts.profile?.trim() || await askProfileName(resolvedProfile.name);
|
|
const apiKeyEnvVarName = opts.apiKeyEnvVarName?.trim() || "PAPERCLIP_API_KEY";
|
|
|
|
if (persona === "board") {
|
|
const company = await chooseCompany(companies, opts.companyId ?? resolvedProfile.profile.companyId, {
|
|
optional: true,
|
|
});
|
|
const tokenName = opts.tokenName?.trim() || `cli-board-${new Date().toISOString()}`;
|
|
const key = await boardApi.post<CreatedBoardKey>("/api/board-api-keys", createBoardApiKeySchema.parse({
|
|
name: tokenName,
|
|
requestedCompanyId: company?.id ?? null,
|
|
}));
|
|
if (!key) throw new Error("Failed to create board token");
|
|
upsertProfile(profileName, {
|
|
apiBase,
|
|
companyId: company?.id,
|
|
persona: "board",
|
|
agentId: "",
|
|
agentName: "",
|
|
apiKeyEnvVarName,
|
|
tokenName: key.name,
|
|
tokenId: key.id,
|
|
tokenCreatedAt: key.createdAt,
|
|
}, opts.context);
|
|
setCurrentProfile(profileName, opts.context);
|
|
p.outro(pc.green(`Connected profile '${profileName}' as board.`));
|
|
return {
|
|
ok: true,
|
|
profile: profileName,
|
|
persona: "board",
|
|
apiBase,
|
|
companyId: company?.id ?? null,
|
|
key: publicKeyResult(key),
|
|
exports: buildExports({ apiBase, companyId: company?.id, agentId: undefined, envName: apiKeyEnvVarName, token: key.token }),
|
|
};
|
|
}
|
|
|
|
const company = await chooseCompany(companies, opts.companyId ?? resolvedProfile.profile.companyId, {
|
|
optional: false,
|
|
});
|
|
if (!company) throw new Error("Company is required for agent profiles");
|
|
const agents = (await boardApi.get<Agent[]>(apiPath`/api/companies/${company.id}/agents`)) ?? [];
|
|
if (agents.length === 0) throw new Error(`Company '${company.name}' has no agents to connect.`);
|
|
const agent = await chooseAgent(agents, resolvedProfile.profile.agentId);
|
|
const tokenName = opts.tokenName?.trim() || `cli-agent-${new Date().toISOString()}`;
|
|
const key = await boardApi.post<CreatedAgentKey>(apiPath`/api/agents/${agent.id}/keys`, createAgentKeySchema.parse({ name: tokenName }));
|
|
if (!key) throw new Error("Failed to create agent token");
|
|
upsertProfile(profileName, {
|
|
apiBase,
|
|
companyId: company.id,
|
|
persona: "agent",
|
|
agentId: agent.id,
|
|
agentName: agent.name,
|
|
apiKeyEnvVarName,
|
|
tokenName: key.name,
|
|
tokenId: key.id,
|
|
tokenCreatedAt: key.createdAt,
|
|
}, opts.context);
|
|
setCurrentProfile(profileName, opts.context);
|
|
p.outro(pc.green(`Connected profile '${profileName}' as ${agent.name}.`));
|
|
return {
|
|
ok: true,
|
|
profile: profileName,
|
|
persona: "agent",
|
|
apiBase,
|
|
companyId: company.id,
|
|
agentId: agent.id,
|
|
agentName: agent.name,
|
|
key: publicKeyResult(key),
|
|
exports: buildExports({ apiBase, companyId: company.id, agentId: agent.id, envName: apiKeyEnvVarName, token: key.token }),
|
|
};
|
|
}
|
|
|
|
async function verifyHealth(apiBase: string): Promise<void> {
|
|
const api = new PaperclipApiClient({ apiBase });
|
|
await api.get("/api/health");
|
|
}
|
|
|
|
async function choosePersona(input: string | undefined): Promise<"board" | "agent"> {
|
|
if (input === "board" || input === "agent") return input;
|
|
const selected = await p.select({
|
|
message: "Connect as",
|
|
options: [
|
|
{ value: "board", label: "Board operator" },
|
|
{ value: "agent", label: "Agent in a company" },
|
|
],
|
|
});
|
|
assertNotCancelled(selected);
|
|
return selected as "board" | "agent";
|
|
}
|
|
|
|
async function askProfileName(defaultName: string): Promise<string> {
|
|
const profile = await p.text({
|
|
message: "Profile name",
|
|
initialValue: defaultName || "default",
|
|
});
|
|
assertNotCancelled(profile);
|
|
const value = String(profile).trim();
|
|
if (!value) throw new Error("Profile name is required");
|
|
return value;
|
|
}
|
|
|
|
async function chooseCompany(
|
|
companies: Company[],
|
|
preferredCompanyId: string | undefined,
|
|
opts: { optional: boolean },
|
|
): Promise<Company | null> {
|
|
if (companies.length === 0) {
|
|
if (opts.optional) return null;
|
|
throw new Error("No companies are accessible with this board credential.");
|
|
}
|
|
const preferred = preferredCompanyId ? companies.find((company) => company.id === preferredCompanyId) : null;
|
|
if (companies.length === 1 && !opts.optional) return companies[0] ?? null;
|
|
const selected = await p.select({
|
|
message: opts.optional ? "Default company for this profile" : "Agent company",
|
|
initialValue: preferred?.id ?? companies[0]?.id,
|
|
options: [
|
|
...(opts.optional ? [{ value: "", label: "(none)" }] : []),
|
|
...companies.map((company) => ({
|
|
value: company.id,
|
|
label: company.name,
|
|
hint: company.id,
|
|
})),
|
|
],
|
|
});
|
|
assertNotCancelled(selected);
|
|
if (!selected) return null;
|
|
return companies.find((company) => company.id === selected) ?? null;
|
|
}
|
|
|
|
async function chooseAgent(agents: Agent[], preferredAgentId: string | undefined): Promise<Agent> {
|
|
const selected = await p.select({
|
|
message: "Agent",
|
|
initialValue: preferredAgentId && agents.some((agent) => agent.id === preferredAgentId)
|
|
? preferredAgentId
|
|
: agents[0]?.id,
|
|
options: agents.map((agent) => ({
|
|
value: agent.id,
|
|
label: agent.name,
|
|
hint: agent.role,
|
|
})),
|
|
});
|
|
assertNotCancelled(selected);
|
|
const agent = agents.find((item) => item.id === selected);
|
|
if (!agent) throw new Error("Agent selection failed");
|
|
return agent;
|
|
}
|
|
|
|
function buildExports(input: {
|
|
apiBase: string;
|
|
companyId?: string;
|
|
agentId?: string;
|
|
envName: string;
|
|
token: string;
|
|
}): string {
|
|
const escaped = (value: string) => value.replace(/'/g, "'\"'\"'");
|
|
return [
|
|
`export PAPERCLIP_API_URL='${escaped(input.apiBase)}'`,
|
|
input.companyId ? `export PAPERCLIP_COMPANY_ID='${escaped(input.companyId)}'` : null,
|
|
input.agentId ? `export PAPERCLIP_AGENT_ID='${escaped(input.agentId)}'` : null,
|
|
`export ${input.envName}='${escaped(input.token)}'`,
|
|
].filter((line): line is string => Boolean(line)).join("\n");
|
|
}
|
|
|
|
function publicKeyResult(key: CreatedAgentKey | CreatedBoardKey) {
|
|
return {
|
|
id: key.id,
|
|
name: key.name,
|
|
createdAt: key.createdAt,
|
|
token: key.token,
|
|
expiresAt: "expiresAt" in key ? key.expiresAt : undefined,
|
|
};
|
|
}
|
|
|
|
function assertNotCancelled<T>(value: T | symbol): asserts value is T {
|
|
if (p.isCancel(value)) {
|
|
p.cancel("Cancelled.");
|
|
process.exit(0);
|
|
}
|
|
}
|