mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-09 06:15:21 +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>
159 lines
5.5 KiB
TypeScript
159 lines
5.5 KiB
TypeScript
import { Command } from "commander";
|
|
import pc from "picocolors";
|
|
import {
|
|
readContext,
|
|
resolveContextPath,
|
|
resolveProfile,
|
|
setCurrentProfile,
|
|
upsertProfile,
|
|
type ClientContextProfile,
|
|
} from "../../client/context.js";
|
|
import { printOutput } from "./common.js";
|
|
|
|
interface ContextOptions {
|
|
dataDir?: string;
|
|
context?: string;
|
|
profile?: string;
|
|
json?: boolean;
|
|
}
|
|
|
|
interface ContextSetOptions extends ContextOptions {
|
|
apiBase?: string;
|
|
companyId?: string;
|
|
persona?: "board" | "agent";
|
|
agentId?: string;
|
|
agentName?: string;
|
|
apiKeyEnvVarName?: string;
|
|
use?: boolean;
|
|
}
|
|
|
|
export function registerContextCommands(program: Command): void {
|
|
const context = program.command("context").description("Manage CLI client context profiles");
|
|
|
|
context
|
|
.command("show")
|
|
.description("Show current context and active profile")
|
|
.option("-d, --data-dir <path>", "Paperclip data directory root (isolates state from ~/.paperclip)")
|
|
.option("--context <path>", "Path to CLI context file")
|
|
.option("--profile <name>", "Profile to inspect")
|
|
.option("--json", "Output raw JSON")
|
|
.action((opts: ContextOptions) => {
|
|
const contextPath = resolveContextPath(opts.context);
|
|
const store = readContext(opts.context);
|
|
const resolved = resolveProfile(store, opts.profile);
|
|
const payload = {
|
|
contextPath,
|
|
currentProfile: store.currentProfile,
|
|
profileName: resolved.name,
|
|
profile: resolved.profile,
|
|
profiles: store.profiles,
|
|
};
|
|
printOutput(payload, { json: opts.json });
|
|
});
|
|
|
|
context
|
|
.command("list")
|
|
.description("List available context profiles")
|
|
.option("-d, --data-dir <path>", "Paperclip data directory root (isolates state from ~/.paperclip)")
|
|
.option("--context <path>", "Path to CLI context file")
|
|
.option("--json", "Output raw JSON")
|
|
.action((opts: ContextOptions) => {
|
|
const store = readContext(opts.context);
|
|
const rows = Object.entries(store.profiles).map(([name, profile]) => ({
|
|
name,
|
|
current: name === store.currentProfile,
|
|
apiBase: profile.apiBase ?? null,
|
|
companyId: profile.companyId ?? null,
|
|
persona: profile.persona ?? null,
|
|
agentId: profile.agentId ?? null,
|
|
agentName: profile.agentName ?? null,
|
|
apiKeyEnvVarName: profile.apiKeyEnvVarName ?? null,
|
|
}));
|
|
printOutput(rows, { json: opts.json });
|
|
});
|
|
|
|
context
|
|
.command("use")
|
|
.description("Set active context profile")
|
|
.argument("<profile>", "Profile name")
|
|
.option("-d, --data-dir <path>", "Paperclip data directory root (isolates state from ~/.paperclip)")
|
|
.option("--context <path>", "Path to CLI context file")
|
|
.action((profile: string, opts: ContextOptions) => {
|
|
setCurrentProfile(profile, opts.context);
|
|
console.log(pc.green(`Active profile set to '${profile}'.`));
|
|
});
|
|
|
|
context
|
|
.command("set")
|
|
.description("Set values on a profile")
|
|
.option("-d, --data-dir <path>", "Paperclip data directory root (isolates state from ~/.paperclip)")
|
|
.option("--context <path>", "Path to CLI context file")
|
|
.option("--profile <name>", "Profile name (default: current profile)")
|
|
.option("--api-base <url>", "Default API base URL")
|
|
.option("--company-id <id>", "Default company ID")
|
|
.option("--persona <persona>", "Profile persona: board or agent")
|
|
.option("--agent-id <id>", "Default agent ID for agent persona")
|
|
.option("--agent-name <name>", "Default agent display name")
|
|
.option("--api-key-env-var-name <name>", "Env var containing API key (recommended)")
|
|
.option("--use", "Set this profile as active")
|
|
.option("--json", "Output raw JSON")
|
|
.action((opts: ContextSetOptions) => {
|
|
const existing = readContext(opts.context);
|
|
const targetProfile = opts.profile?.trim() || existing.currentProfile || "default";
|
|
|
|
upsertProfile(
|
|
targetProfile,
|
|
buildContextPatch(opts),
|
|
opts.context,
|
|
);
|
|
|
|
if (opts.use) {
|
|
setCurrentProfile(targetProfile, opts.context);
|
|
}
|
|
|
|
const updated = readContext(opts.context);
|
|
const resolved = resolveProfile(updated, targetProfile);
|
|
const payload = {
|
|
contextPath: resolveContextPath(opts.context),
|
|
currentProfile: updated.currentProfile,
|
|
profileName: resolved.name,
|
|
profile: resolved.profile,
|
|
};
|
|
|
|
if (!opts.json) {
|
|
console.log(pc.green(`Updated profile '${targetProfile}'.`));
|
|
if (opts.use) {
|
|
console.log(pc.green(`Set '${targetProfile}' as active profile.`));
|
|
}
|
|
}
|
|
printOutput(payload, { json: opts.json });
|
|
});
|
|
}
|
|
|
|
function setIfProvided<K extends keyof ClientContextProfile>(
|
|
patch: Partial<ClientContextProfile>,
|
|
key: K,
|
|
value: ClientContextProfile[K] | undefined,
|
|
): void {
|
|
if (value !== undefined) {
|
|
patch[key] = value;
|
|
}
|
|
}
|
|
|
|
function buildContextPatch(opts: ContextSetOptions): Partial<ClientContextProfile> {
|
|
const patch: Partial<ClientContextProfile> = {};
|
|
setIfProvided(patch, "apiBase", opts.apiBase);
|
|
setIfProvided(patch, "companyId", opts.companyId);
|
|
setIfProvided(patch, "persona", parsePersona(opts.persona));
|
|
setIfProvided(patch, "agentId", opts.agentId);
|
|
setIfProvided(patch, "agentName", opts.agentName);
|
|
setIfProvided(patch, "apiKeyEnvVarName", opts.apiKeyEnvVarName);
|
|
return patch;
|
|
}
|
|
|
|
function parsePersona(value: string | undefined): "board" | "agent" | undefined {
|
|
if (value === undefined) return undefined;
|
|
if (value === "board" || value === "agent") return value;
|
|
throw new Error("Invalid --persona value. Use board or agent.");
|
|
}
|