mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-17 11:20:37 +09:00
Improve CLI API parity coverage (#6626)
## 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>
This commit is contained in:
Aron Prins
GitHub
parent
68401f82f3
commit
70b1a9109d
74 changed files with 18175 additions and 111 deletions
465
doc/CLI.md
465
doc/CLI.md
|
|
@ -65,6 +65,29 @@ All client commands support:
|
|||
|
||||
Company-scoped commands also support `--company-id <id>`.
|
||||
|
||||
API base resolution order:
|
||||
|
||||
1. `--api-base <url>`
|
||||
2. `PAPERCLIP_API_URL`
|
||||
3. selected context profile `apiBase`
|
||||
4. local Paperclip config server port
|
||||
5. `http://localhost:3100`
|
||||
|
||||
Connection failures include the attempted URL and a `GET /api/health` check hint.
|
||||
|
||||
## Connect Wizard
|
||||
|
||||
```sh
|
||||
pnpm paperclipai connect
|
||||
```
|
||||
|
||||
`connect` confirms the resolved API base, verifies `GET /api/health`, authenticates board access when needed, and saves a persona-aware profile:
|
||||
|
||||
- `persona=board` for board operator profiles
|
||||
- `persona=agent` with `agentId` and `agentName` for agent profiles
|
||||
|
||||
Profiles store token env-var names, not plaintext tokens. The wizard prints shell exports for the newly created token.
|
||||
|
||||
Use `--data-dir` on any CLI command to isolate all default local state (config/context/db/logs/storage/secrets) away from `~/.paperclip`:
|
||||
|
||||
```sh
|
||||
|
|
@ -78,6 +101,7 @@ Store local defaults in `~/.paperclip/context.json`:
|
|||
|
||||
```sh
|
||||
pnpm paperclipai context set --api-base http://localhost:3100 --company-id <company-id>
|
||||
pnpm paperclipai context set --persona agent --agent-id <agent-id> --api-key-env-var-name PAPERCLIP_API_KEY
|
||||
pnpm paperclipai context show
|
||||
pnpm paperclipai context list
|
||||
pnpm paperclipai context use default
|
||||
|
|
@ -95,6 +119,17 @@ export PAPERCLIP_API_KEY=...
|
|||
```sh
|
||||
pnpm paperclipai company list
|
||||
pnpm paperclipai company get <company-id>
|
||||
pnpm paperclipai company stats
|
||||
pnpm paperclipai company create --payload-json '{...}'
|
||||
pnpm paperclipai company update <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai company branding:update <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai company archive <company-id>
|
||||
pnpm paperclipai company export <company-id> --out ./company --include company,agents,projects,issues,skills
|
||||
pnpm paperclipai company export:preview <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai company export:api <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai company import ./company --target new --new-company-name "Imported Company"
|
||||
pnpm paperclipai company import:preview <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai company import:apply <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai company delete <company-id-or-prefix> --yes --confirm <same-id-or-prefix>
|
||||
```
|
||||
|
||||
|
|
@ -117,9 +152,102 @@ pnpm paperclipai issue list --company-id <company-id> [--status todo,in_progress
|
|||
pnpm paperclipai issue get <issue-id-or-identifier>
|
||||
pnpm paperclipai issue create --company-id <company-id> --title "..." [--description "..."] [--status todo] [--priority high]
|
||||
pnpm paperclipai issue update <issue-id> [--status in_progress] [--comment "..."]
|
||||
pnpm paperclipai issue delete <issue-id> --yes
|
||||
pnpm paperclipai issue comment <issue-id> --body "..." [--reopen]
|
||||
pnpm paperclipai issue comments <issue-id> [--limit 50]
|
||||
pnpm paperclipai issue comment:get <issue-id> <comment-id>
|
||||
pnpm paperclipai issue comment:delete <issue-id> <comment-id>
|
||||
pnpm paperclipai issue runs <issue-id-or-identifier>
|
||||
pnpm paperclipai issue live-runs <issue-id-or-identifier>
|
||||
pnpm paperclipai issue active-run <issue-id-or-identifier>
|
||||
pnpm paperclipai issue heartbeat-context <issue-id>
|
||||
pnpm paperclipai issue checkout <issue-id> --agent-id <agent-id> [--expected-statuses todo,backlog,blocked]
|
||||
pnpm paperclipai issue release <issue-id>
|
||||
pnpm paperclipai issue force-release <issue-id>
|
||||
```
|
||||
|
||||
Issue subresources are exposed as Paperclip API wrappers. Commands that map to broad server schemas accept JSON payloads and validate them with shared schemas before sending.
|
||||
|
||||
```sh
|
||||
pnpm paperclipai issue child:create <issue-id> --payload-json '{"title":"Child task"}'
|
||||
pnpm paperclipai issue approvals <issue-id>
|
||||
pnpm paperclipai issue approval:link <issue-id> <approval-id>
|
||||
pnpm paperclipai issue approval:unlink <issue-id> <approval-id>
|
||||
pnpm paperclipai issue read <issue-id>
|
||||
pnpm paperclipai issue unread <issue-id>
|
||||
pnpm paperclipai issue archive <issue-id>
|
||||
pnpm paperclipai issue unarchive <issue-id>
|
||||
pnpm paperclipai issue recovery-actions <issue-id>
|
||||
pnpm paperclipai issue recovery:resolve <issue-id> --outcome restored --source-issue-status todo
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm paperclipai issue documents <issue-id> [--include-system]
|
||||
pnpm paperclipai issue document:get <issue-id> <key>
|
||||
pnpm paperclipai issue document:put <issue-id> <key> --body-file ./plan.md [--title Plan]
|
||||
pnpm paperclipai issue document:lock <issue-id> <key>
|
||||
pnpm paperclipai issue document:unlock <issue-id> <key>
|
||||
pnpm paperclipai issue document:revisions <issue-id> <key>
|
||||
pnpm paperclipai issue document:restore <issue-id> <key> <revision-id>
|
||||
pnpm paperclipai issue document:delete <issue-id> <key>
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm paperclipai issue work-products <issue-id>
|
||||
pnpm paperclipai issue work-product:create <issue-id> --payload-json '{"type":"pull_request","provider":"github","title":"PR"}'
|
||||
pnpm paperclipai issue work-product:update <work-product-id> --payload-json '{"status":"archived"}'
|
||||
pnpm paperclipai issue work-product:delete <work-product-id>
|
||||
pnpm paperclipai issue interactions <issue-id>
|
||||
pnpm paperclipai issue interaction:create <issue-id> --payload-json '{"kind":"request_confirmation","payload":{"version":1,"prompt":"Continue?"}}'
|
||||
pnpm paperclipai issue interaction:accept <issue-id> <interaction-id> [--selected-client-keys key1,key2]
|
||||
pnpm paperclipai issue interaction:reject <issue-id> <interaction-id> [--reason "..."]
|
||||
pnpm paperclipai issue interaction:respond <issue-id> <interaction-id> --answers-json '[{"questionId":"q1","optionIds":["yes"]}]'
|
||||
pnpm paperclipai issue interaction:cancel <issue-id> <interaction-id> [--reason "..."]
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm paperclipai issue tree-state <issue-id>
|
||||
pnpm paperclipai issue tree-preview <issue-id> --payload-json '{"mode":"pause"}'
|
||||
pnpm paperclipai issue tree-holds <issue-id> [--status active] [--include-members]
|
||||
pnpm paperclipai issue tree-hold:create <issue-id> --payload-json '{"mode":"pause","reason":"review"}'
|
||||
pnpm paperclipai issue tree-hold:get <issue-id> <hold-id>
|
||||
pnpm paperclipai issue tree-hold:release <issue-id> <hold-id> [--payload-json '{"reason":"done"}']
|
||||
pnpm paperclipai issue attachments <issue-id>
|
||||
pnpm paperclipai issue attachment:upload <issue-id> --company-id <company-id> --file ./artifact.txt
|
||||
pnpm paperclipai issue attachment:download <attachment-id> [--out ./artifact.txt]
|
||||
pnpm paperclipai issue attachment:delete <attachment-id>
|
||||
pnpm paperclipai issue label:list --company-id <company-id>
|
||||
pnpm paperclipai issue label:create --company-id <company-id> --name bug --color '#ff0000'
|
||||
pnpm paperclipai issue label:delete <label-id>
|
||||
pnpm paperclipai issue feedback:votes <issue-id>
|
||||
pnpm paperclipai issue feedback:vote <issue-id> --payload-json '{"targetType":"issue_comment","targetId":"...","vote":"up"}'
|
||||
```
|
||||
|
||||
## Project Commands
|
||||
|
||||
```sh
|
||||
pnpm paperclipai project list --company-id <company-id>
|
||||
pnpm paperclipai project get <project-id-or-shortname> [--company-id <company-id>]
|
||||
pnpm paperclipai project create --company-id <company-id> --name "Launch Site" [--goal-ids <id1,id2>] [--lead-agent-id <id>]
|
||||
pnpm paperclipai project update <project-id-or-shortname> [--status in_progress] [--company-id <company-id>]
|
||||
pnpm paperclipai project delete <project-id-or-shortname> --yes [--company-id <company-id>]
|
||||
```
|
||||
|
||||
Advanced project fields accept JSON:
|
||||
|
||||
```sh
|
||||
pnpm paperclipai project create --company-id <company-id> --name "Ops" --env-json '{"OPENAI_API_KEY":{"kind":"secret","secretName":"openai-api-key"}}'
|
||||
pnpm paperclipai project update <project-id> --execution-workspace-policy-json '{"enabled":true,"defaultMode":"shared_workspace"}'
|
||||
```
|
||||
|
||||
## Goal Commands
|
||||
|
||||
```sh
|
||||
pnpm paperclipai goal list --company-id <company-id>
|
||||
pnpm paperclipai goal get <goal-id>
|
||||
pnpm paperclipai goal create --company-id <company-id> --title "Grow revenue" [--level company] [--status active]
|
||||
pnpm paperclipai goal update <goal-id> [--title "..."] [--status achieved]
|
||||
pnpm paperclipai goal delete <goal-id> --yes
|
||||
```
|
||||
|
||||
## Agent Commands
|
||||
|
|
@ -127,9 +255,44 @@ pnpm paperclipai issue release <issue-id>
|
|||
```sh
|
||||
pnpm paperclipai agent list --company-id <company-id>
|
||||
pnpm paperclipai agent get <agent-id>
|
||||
pnpm paperclipai agent create --company-id <company-id> --payload-json '{"name":"Builder","adapterType":"codex_local"}'
|
||||
pnpm paperclipai agent hire --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai agent update <agent-id> --payload-json '{"title":"Senior Builder"}'
|
||||
pnpm paperclipai agent delete <agent-id> --yes
|
||||
pnpm paperclipai agent me
|
||||
pnpm paperclipai agent inbox
|
||||
pnpm paperclipai agent inbox-mine --user-id <board-user-id>
|
||||
pnpm paperclipai agent wake <agent-id-or-shortname> [--company-id <company-id>] [--reason "..."] [--payload '{"issueId":"..."}']
|
||||
pnpm paperclipai agent pause <agent-id>
|
||||
pnpm paperclipai agent resume <agent-id>
|
||||
pnpm paperclipai agent approve <agent-id>
|
||||
pnpm paperclipai agent terminate <agent-id>
|
||||
pnpm paperclipai agent heartbeat:invoke <agent-id>
|
||||
pnpm paperclipai agent claude-login <agent-id>
|
||||
pnpm paperclipai agent local-cli <agent-id-or-shortname> --company-id <company-id>
|
||||
```
|
||||
|
||||
Agent configuration and runtime endpoints:
|
||||
|
||||
```sh
|
||||
pnpm paperclipai agent permissions:update <agent-id> --payload-json '{"canCreateAgents":true,"canAssignTasks":true}'
|
||||
pnpm paperclipai agent configuration <agent-id>
|
||||
pnpm paperclipai agent config-revisions <agent-id>
|
||||
pnpm paperclipai agent config-revision:get <agent-id> <revision-id>
|
||||
pnpm paperclipai agent config-revision:rollback <agent-id> <revision-id>
|
||||
pnpm paperclipai agent runtime-state <agent-id>
|
||||
pnpm paperclipai agent runtime-state:reset-session <agent-id> [--task-key <key>]
|
||||
pnpm paperclipai agent task-sessions <agent-id>
|
||||
pnpm paperclipai agent skills <agent-id>
|
||||
pnpm paperclipai agent skills:sync <agent-id> --desired-skills paperclip,github
|
||||
pnpm paperclipai agent instructions-path:update <agent-id> --payload-json '{"path":"/path/to/AGENTS.md"}'
|
||||
pnpm paperclipai agent instructions-bundle <agent-id>
|
||||
pnpm paperclipai agent instructions-bundle:update <agent-id> --payload-json '{"mode":"managed"}'
|
||||
pnpm paperclipai agent instructions-file:get <agent-id> --path AGENTS.md
|
||||
pnpm paperclipai agent instructions-file:put <agent-id> --path AGENTS.md --content-file ./AGENTS.md
|
||||
pnpm paperclipai agent instructions-file:delete <agent-id> --path AGENTS.md
|
||||
```
|
||||
|
||||
`agent local-cli` is the quickest way to run local Claude/Codex manually as a Paperclip agent:
|
||||
|
||||
- creates a new long-lived agent API key
|
||||
|
|
@ -143,6 +306,75 @@ pnpm paperclipai agent local-cli codexcoder --company-id <company-id>
|
|||
pnpm paperclipai agent local-cli claudecoder --company-id <company-id>
|
||||
```
|
||||
|
||||
## Token Commands
|
||||
|
||||
Agent API keys are scoped to one company and one agent. Plaintext tokens are printed once at creation.
|
||||
|
||||
```sh
|
||||
pnpm paperclipai token agent create --company-id <company-id> --agent <agent-id-or-name> --name external-worker
|
||||
pnpm paperclipai token agent list --company-id <company-id> --agent <agent-id-or-name>
|
||||
pnpm paperclipai token agent revoke --company-id <company-id> --agent <agent-id-or-name> <key-id>
|
||||
```
|
||||
|
||||
Named board API keys use the board authorization model, support revocation and expiration metadata, and are audited server-side.
|
||||
|
||||
```sh
|
||||
pnpm paperclipai token board create --company-id <company-id> --name external-admin
|
||||
pnpm paperclipai token board create --name short-lived --ttl-days 7
|
||||
pnpm paperclipai token board list
|
||||
pnpm paperclipai token board revoke <key-id>
|
||||
```
|
||||
|
||||
## Run Commands
|
||||
|
||||
`paperclipai run` without a subcommand still bootstraps and starts a local Paperclip instance. The subcommands below inspect and control API heartbeat runs.
|
||||
|
||||
```sh
|
||||
pnpm paperclipai run list --company-id <company-id> [--agent-id <agent-id>] [--limit 50]
|
||||
pnpm paperclipai run live --company-id <company-id> [--limit 50] [--min-count 0]
|
||||
pnpm paperclipai run get <run-id>
|
||||
pnpm paperclipai run events <run-id> [--after-seq 0] [--limit 200]
|
||||
pnpm paperclipai run log <run-id> [--offset 0] [--limit-bytes 16384] [--text]
|
||||
pnpm paperclipai run cancel <run-id>
|
||||
pnpm paperclipai run issues <run-id>
|
||||
pnpm paperclipai run workspace-operations <run-id>
|
||||
pnpm paperclipai run workspace-log <operation-id> [--offset 0] [--limit-bytes 16384] [--text]
|
||||
pnpm paperclipai run watchdog-decision <run-id> --decision continue [--reason "..."]
|
||||
```
|
||||
|
||||
## Routine Commands
|
||||
|
||||
`paperclipai routines disable-all` remains the local maintenance command. The singular `routine` group maps to the REST API.
|
||||
|
||||
```sh
|
||||
pnpm paperclipai routine list --company-id <company-id> [--project-id <project-id>]
|
||||
pnpm paperclipai routine create --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai routine get <routine-id>
|
||||
pnpm paperclipai routine update <routine-id> --payload-json '{...}'
|
||||
pnpm paperclipai routine revisions <routine-id>
|
||||
pnpm paperclipai routine revision:restore <routine-id> <revision-id>
|
||||
pnpm paperclipai routine runs <routine-id> [--limit 50]
|
||||
pnpm paperclipai routine run <routine-id> [--payload-json '{...}']
|
||||
pnpm paperclipai routine trigger:create <routine-id> --payload-json '{...}'
|
||||
pnpm paperclipai routine trigger:update <trigger-id> --payload-json '{...}'
|
||||
pnpm paperclipai routine trigger:delete <trigger-id>
|
||||
pnpm paperclipai routine trigger:rotate-secret <trigger-id>
|
||||
pnpm paperclipai routine trigger:fire <public-id> [--payload-json '{...}']
|
||||
```
|
||||
|
||||
## Prompt Handoff
|
||||
|
||||
Prompt handoff creates Paperclip work. It does not create a chat session.
|
||||
|
||||
```sh
|
||||
pnpm paperclipai agent-prompt <agent-name-or-id> <agent-api-key> "Prompt here"
|
||||
pnpm paperclipai agent prompt --agent <agent-name-or-id> --api-key-env PAPERCLIP_API_KEY "Prompt here"
|
||||
pnpm paperclipai agent prompt --profile my-agent "Prompt here"
|
||||
pnpm paperclipai board prompt --company-id <company-id> --agent <agent-name-or-id> "Prompt here"
|
||||
```
|
||||
|
||||
By default the command creates a `todo` issue assigned to the target agent and wakes the agent. Use `--issue <issue-id>` to add a comment to existing work, and `--no-wake` to skip the wakeup.
|
||||
|
||||
## Skills Commands
|
||||
|
||||
`paperclipai skills` covers three distinct operations:
|
||||
|
|
@ -269,6 +501,16 @@ pnpm paperclipai secrets declarations --company-id <company-id> [--include agent
|
|||
pnpm paperclipai secrets create --company-id <company-id> --name anthropic-api-key --value-env ANTHROPIC_API_KEY
|
||||
pnpm paperclipai secrets link --company-id <company-id> --name prod-stripe-key --provider aws_secrets_manager --external-ref <provider-ref>
|
||||
pnpm paperclipai secrets doctor --company-id <company-id>
|
||||
pnpm paperclipai secrets provider-configs --company-id <company-id>
|
||||
pnpm paperclipai secrets provider-config:create --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai secrets provider-config:discovery-preview --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai secrets provider-config:get <config-id>
|
||||
pnpm paperclipai secrets provider-config:update <config-id> --payload-json '{...}'
|
||||
pnpm paperclipai secrets provider-config:default <config-id>
|
||||
pnpm paperclipai secrets provider-config:health <config-id>
|
||||
pnpm paperclipai secrets provider-config:delete <config-id>
|
||||
pnpm paperclipai secrets remote-import:preview --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai secrets remote-import --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai secrets migrate-inline-env --company-id <company-id> [--apply]
|
||||
```
|
||||
|
||||
|
|
@ -280,10 +522,9 @@ env and the expected AWS SDK runtime credential source; do not store AWS
|
|||
bootstrap credentials in Paperclip secrets.
|
||||
|
||||
Per-company provider vaults (multiple vault instances per provider, default
|
||||
vault selection, coming-soon GCP/Vault) are configured from the board UI under
|
||||
`Company Settings → Secrets → Provider vaults` or through
|
||||
`/api/companies/{companyId}/secret-provider-configs`. There is no CLI surface
|
||||
for vault management today. See the
|
||||
vault selection, coming-soon GCP/Vault) can be configured from the board UI under
|
||||
`Company Settings → Secrets → Provider vaults` or through the provider-config CLI
|
||||
commands above. See the
|
||||
[secrets deploy guide](../docs/deploy/secrets.md#provider-vaults) and
|
||||
[API reference](../docs/api/secrets.md#provider-vaults) for the contract.
|
||||
|
||||
|
|
@ -304,6 +545,8 @@ pnpm paperclipai approval comment <approval-id> --body "..."
|
|||
|
||||
```sh
|
||||
pnpm paperclipai activity list --company-id <company-id> [--agent-id <agent-id>] [--entity-type issue] [--entity-id <id>]
|
||||
pnpm paperclipai activity create --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai activity issue <issue-id>
|
||||
```
|
||||
|
||||
## Dashboard Commands
|
||||
|
|
@ -312,6 +555,220 @@ pnpm paperclipai activity list --company-id <company-id> [--agent-id <agent-id>]
|
|||
pnpm paperclipai dashboard get --company-id <company-id>
|
||||
```
|
||||
|
||||
## Org And Agent Config Commands
|
||||
|
||||
```sh
|
||||
pnpm paperclipai whoami
|
||||
pnpm paperclipai openapi
|
||||
pnpm paperclipai org get --company-id <company-id>
|
||||
pnpm paperclipai org svg --company-id <company-id> [--out org.svg]
|
||||
pnpm paperclipai org png --company-id <company-id> [--out org.png]
|
||||
pnpm paperclipai agent-config list --company-id <company-id>
|
||||
```
|
||||
|
||||
## Access, Profile, And Instance Commands
|
||||
|
||||
```sh
|
||||
pnpm paperclipai profile session
|
||||
pnpm paperclipai profile get
|
||||
pnpm paperclipai profile update --payload-json '{...}'
|
||||
pnpm paperclipai profile company-user <user-slug> --company-id <company-id>
|
||||
pnpm paperclipai invite list --company-id <company-id>
|
||||
pnpm paperclipai invite create --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai invite revoke <invite-id>
|
||||
pnpm paperclipai invite show <token>
|
||||
pnpm paperclipai invite accept <token> [--payload-json '{...}']
|
||||
pnpm paperclipai invite onboarding:text <token>
|
||||
pnpm paperclipai join list --company-id <company-id> [--status pending_approval]
|
||||
pnpm paperclipai join approve <request-id> --company-id <company-id>
|
||||
pnpm paperclipai join reject <request-id> --company-id <company-id>
|
||||
pnpm paperclipai join claim-key <request-id> --claim-secret <secret>
|
||||
pnpm paperclipai member list --company-id <company-id>
|
||||
pnpm paperclipai member update <member-id> --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai member role-and-grants <member-id> --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai member permissions <member-id> --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai member archive <member-id> --company-id <company-id> [--payload-json '{...}']
|
||||
pnpm paperclipai admin user list [--query <text>]
|
||||
pnpm paperclipai admin user promote <user-id>
|
||||
pnpm paperclipai admin user demote <user-id>
|
||||
pnpm paperclipai admin user company-access <user-id>
|
||||
pnpm paperclipai admin user company-access:update <user-id> --payload-json '{...}'
|
||||
```
|
||||
|
||||
CLI auth challenge endpoints are also exposed for tooling that needs the raw challenge lifecycle:
|
||||
|
||||
```sh
|
||||
pnpm paperclipai auth challenge create --payload-json '{...}'
|
||||
PAPERCLIP_CHALLENGE_SECRET=<challenge-secret> pnpm paperclipai auth challenge get <challenge-id> --token-env PAPERCLIP_CHALLENGE_SECRET
|
||||
PAPERCLIP_CHALLENGE_SECRET=<challenge-secret> pnpm paperclipai auth challenge approve <challenge-id> --token-env PAPERCLIP_CHALLENGE_SECRET
|
||||
PAPERCLIP_CHALLENGE_SECRET=<challenge-secret> pnpm paperclipai auth challenge cancel <challenge-id> --token-env PAPERCLIP_CHALLENGE_SECRET
|
||||
pnpm paperclipai auth revoke-current
|
||||
```
|
||||
|
||||
`--token <challenge-secret>` is still supported for compatibility, but `--token-env` avoids putting challenge secrets in shell history or process arguments.
|
||||
|
||||
```sh
|
||||
pnpm paperclipai instance scheduler-heartbeats
|
||||
pnpm paperclipai instance settings:general
|
||||
pnpm paperclipai instance settings:general:update --payload-json '{...}'
|
||||
pnpm paperclipai instance settings:experimental
|
||||
pnpm paperclipai instance settings:experimental:update --payload-json '{...}'
|
||||
pnpm paperclipai instance database-backup
|
||||
pnpm paperclipai sidebar preferences
|
||||
pnpm paperclipai sidebar preferences:update --payload-json '{...}'
|
||||
pnpm paperclipai sidebar project-preferences --company-id <company-id>
|
||||
pnpm paperclipai sidebar project-preferences:update --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai sidebar badges --company-id <company-id>
|
||||
pnpm paperclipai inbox dismissals --company-id <company-id>
|
||||
pnpm paperclipai inbox dismiss --company-id <company-id> --payload-json '{"itemKey":"run:<run-id>"}'
|
||||
pnpm paperclipai board-claim show <token>
|
||||
pnpm paperclipai board-claim claim <token> [--payload-json '{...}']
|
||||
pnpm paperclipai openclaw invite-prompt --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai available-skill list
|
||||
pnpm paperclipai available-skill index
|
||||
pnpm paperclipai available-skill get <skill-name>
|
||||
pnpm paperclipai llm agent-configuration
|
||||
pnpm paperclipai llm agent-configuration:adapter <adapter-type>
|
||||
pnpm paperclipai llm agent-icons
|
||||
```
|
||||
|
||||
## Adapter, Asset, And Skill Commands
|
||||
|
||||
```sh
|
||||
pnpm paperclipai adapter list
|
||||
pnpm paperclipai adapter install --payload-json '{"packageName":"@scope/adapter","version":"1.2.3"}'
|
||||
pnpm paperclipai adapter get <adapter-type>
|
||||
pnpm paperclipai adapter update <adapter-type> --payload-json '{"disabled":true}'
|
||||
pnpm paperclipai adapter override <adapter-type> --payload-json '{"paused":true}'
|
||||
pnpm paperclipai adapter reload <adapter-type>
|
||||
pnpm paperclipai adapter reinstall <adapter-type>
|
||||
pnpm paperclipai adapter delete <adapter-type>
|
||||
pnpm paperclipai adapter config-schema <adapter-type>
|
||||
pnpm paperclipai adapter ui-parser <adapter-type>
|
||||
pnpm paperclipai adapter models <adapter-type> --company-id <company-id> [--refresh] [--environment-id <id>]
|
||||
pnpm paperclipai adapter model-profiles <adapter-type> --company-id <company-id>
|
||||
pnpm paperclipai adapter detect-model <adapter-type> --company-id <company-id>
|
||||
pnpm paperclipai adapter test-environment <adapter-type> --company-id <company-id> --payload-json '{...}'
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm paperclipai asset image:upload --company-id <company-id> --file ./image.png [--namespace docs] [--alt "..."]
|
||||
pnpm paperclipai asset logo:upload --company-id <company-id> --file ./logo.svg
|
||||
pnpm paperclipai asset content <asset-id> --out ./asset.bin
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm paperclipai skill list --company-id <company-id>
|
||||
pnpm paperclipai skill get <skill-id> --company-id <company-id>
|
||||
pnpm paperclipai skill file <skill-id> --company-id <company-id> [--path SKILL.md]
|
||||
pnpm paperclipai skill create --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai skill file:update <skill-id> --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai skill import --company-id <company-id> --payload-json '{"source":"github:owner/repo/path"}'
|
||||
pnpm paperclipai skill scan-projects --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai skill update-status <skill-id> --company-id <company-id>
|
||||
pnpm paperclipai skill install-update <skill-id> --company-id <company-id>
|
||||
pnpm paperclipai skill delete <skill-id> --company-id <company-id>
|
||||
```
|
||||
|
||||
## Cost, Finance, And Budget Commands
|
||||
|
||||
```sh
|
||||
pnpm paperclipai cost summary --company-id <company-id>
|
||||
pnpm paperclipai cost by-agent --company-id <company-id>
|
||||
pnpm paperclipai cost by-agent-model --company-id <company-id>
|
||||
pnpm paperclipai cost by-provider --company-id <company-id>
|
||||
pnpm paperclipai cost by-biller --company-id <company-id>
|
||||
pnpm paperclipai cost by-project --company-id <company-id>
|
||||
pnpm paperclipai cost window-spend --company-id <company-id>
|
||||
pnpm paperclipai cost quota-windows --company-id <company-id>
|
||||
pnpm paperclipai cost issue <issue-id>
|
||||
pnpm paperclipai cost event:create --company-id <company-id> --payload-json '{...}'
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm paperclipai finance event:create --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai finance events --company-id <company-id>
|
||||
pnpm paperclipai finance summary --company-id <company-id>
|
||||
pnpm paperclipai finance by-biller --company-id <company-id>
|
||||
pnpm paperclipai finance by-kind --company-id <company-id>
|
||||
pnpm paperclipai budget overview --company-id <company-id>
|
||||
pnpm paperclipai budget policy:upsert --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai budget company:update --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai budget agent:update <agent-id> --payload-json '{...}'
|
||||
pnpm paperclipai budget incident:resolve <incident-id> --company-id <company-id> [--payload-json '{...}']
|
||||
```
|
||||
|
||||
## Workspace And Environment Commands
|
||||
|
||||
```sh
|
||||
pnpm paperclipai workspace list --company-id <company-id>
|
||||
pnpm paperclipai workspace get <execution-workspace-id>
|
||||
pnpm paperclipai workspace close-readiness <execution-workspace-id>
|
||||
pnpm paperclipai workspace operations <execution-workspace-id>
|
||||
pnpm paperclipai workspace update <execution-workspace-id> --payload-json '{...}'
|
||||
pnpm paperclipai workspace runtime-service <execution-workspace-id> start --payload-json '{...}'
|
||||
pnpm paperclipai workspace runtime-command <execution-workspace-id> run --payload-json '{...}'
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm paperclipai environment list --company-id <company-id>
|
||||
pnpm paperclipai environment capabilities --company-id <company-id>
|
||||
pnpm paperclipai environment create --company-id <company-id> --payload-json '{...}'
|
||||
pnpm paperclipai environment get <environment-id>
|
||||
pnpm paperclipai environment leases <environment-id>
|
||||
pnpm paperclipai environment lease <lease-id>
|
||||
pnpm paperclipai environment update <environment-id> --payload-json '{...}'
|
||||
pnpm paperclipai environment delete <environment-id>
|
||||
pnpm paperclipai environment probe <environment-id>
|
||||
pnpm paperclipai environment probe-config --company-id <company-id> --payload-json '{...}'
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm paperclipai project-workspace list <project-id>
|
||||
pnpm paperclipai project-workspace create <project-id> --payload-json '{...}'
|
||||
pnpm paperclipai project-workspace update <project-id> <workspace-id> --payload-json '{...}'
|
||||
pnpm paperclipai project-workspace delete <project-id> <workspace-id>
|
||||
pnpm paperclipai project-workspace runtime-service <project-id> <workspace-id> restart --payload-json '{...}'
|
||||
pnpm paperclipai project-workspace runtime-command <project-id> <workspace-id> run --payload-json '{...}'
|
||||
```
|
||||
|
||||
## Plugin Commands
|
||||
|
||||
Existing plugin lifecycle commands remain available: `plugin init`, `list`, `install`, `uninstall`, `enable`, `disable`, `inspect`, and `examples`.
|
||||
|
||||
```sh
|
||||
pnpm paperclipai plugin ui-contributions
|
||||
pnpm paperclipai plugin tools
|
||||
pnpm paperclipai plugin tool:execute --payload-json '{...}'
|
||||
pnpm paperclipai plugin health <plugin-id>
|
||||
pnpm paperclipai plugin logs <plugin-id>
|
||||
pnpm paperclipai plugin upgrade <plugin-id>
|
||||
pnpm paperclipai plugin config <plugin-id>
|
||||
pnpm paperclipai plugin config:set <plugin-id> --payload-json '{"configJson":{...}}'
|
||||
pnpm paperclipai plugin config:test <plugin-id> --payload-json '{"configJson":{...}}'
|
||||
pnpm paperclipai plugin jobs <plugin-id>
|
||||
pnpm paperclipai plugin job:runs <plugin-id> <job-id>
|
||||
pnpm paperclipai plugin job:trigger <plugin-id> <job-id> [--payload-json '{...}']
|
||||
pnpm paperclipai plugin webhook <plugin-id> <endpoint-key> [--payload-json '{...}']
|
||||
pnpm paperclipai plugin dashboard <plugin-id>
|
||||
pnpm paperclipai plugin bridge:data <plugin-id> --payload-json '{...}'
|
||||
pnpm paperclipai plugin bridge:action <plugin-id> --payload-json '{...}'
|
||||
pnpm paperclipai plugin bridge:stream <plugin-id> <channel> [--duration-ms 10000]
|
||||
pnpm paperclipai plugin data <plugin-id> <key> --payload-json '{...}'
|
||||
pnpm paperclipai plugin action <plugin-id> <key> --payload-json '{...}'
|
||||
pnpm paperclipai plugin local-folders <plugin-id> --company-id <company-id>
|
||||
pnpm paperclipai plugin local-folder:status <plugin-id> <folder-key> --company-id <company-id>
|
||||
pnpm paperclipai plugin local-folder:validate <plugin-id> <folder-key> --company-id <company-id> [--payload-json '{...}']
|
||||
pnpm paperclipai plugin local-folder:set <plugin-id> <folder-key> --company-id <company-id> --payload-json '{...}'
|
||||
```
|
||||
|
||||
Feedback traces can be fetched directly by ID when automating export workflows:
|
||||
|
||||
```sh
|
||||
pnpm paperclipai feedback trace <trace-id>
|
||||
pnpm paperclipai feedback bundle <trace-id>
|
||||
```
|
||||
|
||||
## Heartbeat Command
|
||||
|
||||
`heartbeat run` now also supports context/api-key options and uses the shared client stack:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue