mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 01:50:39 +09:00
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> |
||
|---|---|---|
| .. | ||
| 2026-02-16-module-system.md | ||
| 2026-02-18-agent-authentication-implementation.md | ||
| 2026-02-18-agent-authentication.md | ||
| 2026-02-19-agent-mgmt-followup-plan.md | ||
| 2026-02-19-ceo-agent-creation-and-hiring.md | ||
| 2026-02-20-issue-run-orchestration-plan.md | ||
| 2026-02-20-storage-system-implementation.md | ||
| 2026-02-21-humans-and-permissions-implementation.md | ||
| 2026-02-21-humans-and-permissions.md | ||
| 2026-02-23-cursor-cloud-adapter.md | ||
| 2026-02-23-deployment-auth-mode-consolidation.md | ||
| 2026-03-10-workspace-strategy-and-git-worktrees.md | ||
| 2026-03-11-agent-chat-ui-and-issue-backed-conversations.md | ||
| 2026-03-13-agent-evals-framework.md | ||
| 2026-03-13-company-import-export-v2.md | ||
| 2026-03-13-features.md | ||
| 2026-03-13-paperclip-skill-tightening-plan.md | ||
| 2026-03-13-plugin-kitchen-sink-example.md | ||
| 2026-03-13-TOKEN-OPTIMIZATION-PLAN.md | ||
| 2026-03-13-workspace-product-model-and-work-product.md | ||
| 2026-03-14-adapter-skill-sync-rollout.md | ||
| 2026-03-14-billing-ledger-and-reporting.md | ||
| 2026-03-14-budget-policies-and-enforcement.md | ||
| 2026-03-14-skills-ui-product-plan.md | ||
| 2026-03-17-docker-release-browser-e2e.md | ||
| 2026-03-17-memory-service-surface-api.md | ||
| 2026-03-17-release-automation-and-versioning.md | ||
| 2026-04-06-smart-model-routing.md | ||
| 2026-04-06-subissue-creation-on-issue-detail.md | ||
| 2026-04-07-issue-detail-speed-and-optimistic-inventory.md | ||
| 2026-04-07-pi-hooks-survey.md | ||
| 2026-04-08-agent-browser-process-cleanup-plan.md | ||
| 2026-04-08-agent-os-follow-up-plan.md | ||
| 2026-04-08-agent-os-technical-report.md | ||
| 2026-04-12-vscode-task-interoperability-plan.md | ||
| 2026-04-26-plugin-secret-ref-company-scope.md | ||
| 2026-05-05-scaled-kanban-board-design.md | ||
| 2026-05-05-scaled-kanban-board.md | ||
| 2026-05-06-llm-wiki-paperclip-asset-security-gate.md | ||
| 2026-05-23-cli-api-parity-openapi-reference.ts | ||
| 2026-05-23-cli-api-parity.md | ||
| 2026-05-26-skills-cli-catalog-contract.md | ||
| workspace-product-model-and-work-product.md | ||
| workspace-technical-implementation.md | ||