70b1a9109d
## 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>
204 lines
5.8 KiB
TypeScript
204 lines
5.8 KiB
TypeScript
import * as p from "@clack/prompts";
|
|
import pc from "picocolors";
|
|
import { readConfig, writeConfig, configExists, resolveConfigPath } from "../config/store.js";
|
|
import type { PaperclipConfig } from "../config/schema.js";
|
|
import { ensureLocalSecretsKeyFile } from "../config/secrets-key.js";
|
|
import { promptDatabase } from "../prompts/database.js";
|
|
import { promptLlm } from "../prompts/llm.js";
|
|
import { promptLogging } from "../prompts/logging.js";
|
|
import { defaultSecretsConfig, promptSecrets } from "../prompts/secrets.js";
|
|
import { defaultStorageConfig, promptStorage } from "../prompts/storage.js";
|
|
import { promptServer } from "../prompts/server.js";
|
|
import {
|
|
resolveDefaultBackupDir,
|
|
resolveDefaultEmbeddedPostgresDir,
|
|
resolveDefaultLogsDir,
|
|
resolvePaperclipInstanceId,
|
|
} from "../config/home.js";
|
|
import { printPaperclipCliBanner } from "../utils/banner.js";
|
|
|
|
type Section = "llm" | "database" | "logging" | "server" | "storage" | "secrets";
|
|
|
|
const SECTION_LABELS: Record<Section, string> = {
|
|
llm: "LLM Provider",
|
|
database: "Database",
|
|
logging: "Logging",
|
|
server: "Server",
|
|
storage: "Storage",
|
|
secrets: "Secrets",
|
|
};
|
|
|
|
function defaultConfig(): PaperclipConfig {
|
|
const instanceId = resolvePaperclipInstanceId();
|
|
return {
|
|
$meta: {
|
|
version: 1,
|
|
updatedAt: new Date().toISOString(),
|
|
source: "configure",
|
|
},
|
|
database: {
|
|
mode: "embedded-postgres",
|
|
embeddedPostgresDataDir: resolveDefaultEmbeddedPostgresDir(instanceId),
|
|
embeddedPostgresPort: 54329,
|
|
backup: {
|
|
enabled: true,
|
|
intervalMinutes: 60,
|
|
retentionDays: 30,
|
|
dir: resolveDefaultBackupDir(instanceId),
|
|
},
|
|
},
|
|
logging: {
|
|
mode: "file",
|
|
logDir: resolveDefaultLogsDir(instanceId),
|
|
},
|
|
server: {
|
|
deploymentMode: "local_trusted",
|
|
exposure: "private",
|
|
bind: "loopback",
|
|
host: "127.0.0.1",
|
|
port: 3100,
|
|
allowedHostnames: [],
|
|
serveUi: true,
|
|
},
|
|
auth: {
|
|
baseUrlMode: "auto",
|
|
disableSignUp: false,
|
|
},
|
|
telemetry: {
|
|
enabled: true,
|
|
},
|
|
storage: defaultStorageConfig(),
|
|
secrets: defaultSecretsConfig(),
|
|
};
|
|
}
|
|
|
|
export async function configure(opts: {
|
|
config?: string;
|
|
section?: string;
|
|
}): Promise<void> {
|
|
printPaperclipCliBanner();
|
|
p.intro(pc.bgCyan(pc.black(" paperclip configure ")));
|
|
const configPath = resolveConfigPath(opts.config);
|
|
|
|
if (!configExists(opts.config)) {
|
|
p.log.error("No config file found. Run `paperclipai onboard` first.");
|
|
p.outro("");
|
|
process.exitCode = 1;
|
|
return;
|
|
}
|
|
|
|
let config: PaperclipConfig;
|
|
try {
|
|
config = readConfig(opts.config) ?? defaultConfig();
|
|
} catch (err) {
|
|
p.log.message(
|
|
pc.yellow(
|
|
`Existing config is invalid. Loading defaults so you can repair it now.\n${err instanceof Error ? err.message : String(err)}`,
|
|
),
|
|
);
|
|
config = defaultConfig();
|
|
}
|
|
|
|
let section: Section | undefined = opts.section as Section | undefined;
|
|
|
|
if (section && !SECTION_LABELS[section]) {
|
|
p.log.error(`Unknown section: ${section}. Choose from: ${Object.keys(SECTION_LABELS).join(", ")}`);
|
|
p.outro("");
|
|
process.exitCode = 1;
|
|
return;
|
|
}
|
|
|
|
// Section selection loop
|
|
let continueLoop = true;
|
|
while (continueLoop) {
|
|
if (!section) {
|
|
const choice = await p.select({
|
|
message: "Which section do you want to configure?",
|
|
options: Object.entries(SECTION_LABELS).map(([value, label]) => ({
|
|
value: value as Section,
|
|
label,
|
|
})),
|
|
});
|
|
|
|
if (p.isCancel(choice)) {
|
|
p.cancel("Configuration cancelled.");
|
|
return;
|
|
}
|
|
|
|
section = choice;
|
|
}
|
|
|
|
p.log.step(pc.bold(SECTION_LABELS[section]));
|
|
|
|
switch (section) {
|
|
case "database":
|
|
config.database = await promptDatabase(config.database);
|
|
break;
|
|
case "llm": {
|
|
const llm = await promptLlm();
|
|
if (llm) {
|
|
config.llm = llm;
|
|
} else {
|
|
delete config.llm;
|
|
}
|
|
break;
|
|
}
|
|
case "logging":
|
|
config.logging = await promptLogging();
|
|
break;
|
|
case "server":
|
|
{
|
|
const { server, auth } = await promptServer({
|
|
currentServer: config.server,
|
|
currentAuth: config.auth,
|
|
});
|
|
config.server = server;
|
|
config.auth = auth;
|
|
}
|
|
break;
|
|
case "storage":
|
|
config.storage = await promptStorage(config.storage);
|
|
break;
|
|
case "secrets":
|
|
config.secrets = await promptSecrets(config.secrets);
|
|
{
|
|
const keyResult = ensureLocalSecretsKeyFile(config, configPath);
|
|
if (keyResult.status === "created") {
|
|
p.log.success(`Created local secrets key file at ${pc.dim(keyResult.path)}`);
|
|
} else if (keyResult.status === "existing") {
|
|
p.log.message(pc.dim(`Using existing local secrets key file at ${keyResult.path}`));
|
|
} else if (keyResult.status === "skipped_provider") {
|
|
p.log.message(pc.dim("Skipping local key file management for non-local provider"));
|
|
} else {
|
|
p.log.message(pc.dim("Skipping local key file management because PAPERCLIP_SECRETS_MASTER_KEY is set"));
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
|
|
config.$meta.updatedAt = new Date().toISOString();
|
|
config.$meta.source = "configure";
|
|
|
|
writeConfig(config, opts.config);
|
|
p.log.success(`${SECTION_LABELS[section]} configuration updated.`);
|
|
|
|
// If section was provided via CLI flag, don't loop
|
|
if (opts.section) {
|
|
continueLoop = false;
|
|
} else {
|
|
const another = await p.confirm({
|
|
message: "Configure another section?",
|
|
initialValue: false,
|
|
});
|
|
|
|
if (p.isCancel(another) || !another) {
|
|
continueLoop = false;
|
|
} else {
|
|
section = undefined; // Reset to show picker again
|
|
}
|
|
}
|
|
}
|
|
|
|
p.outro("Configuration saved.");
|
|
}
|