mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-13 13:38:01 +02:00
DottaandPaperclip
5da382fd59
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Agents can select company skills and synchronize them to adapter runtimes > - The skill sync API replaced the complete selection without an explicit destructive choice > - Company package import also replaced conflicting skills by default > - These defaults could remove operator edits during setup and import reruns > - This pull request adds explicit assignment merge modes and safe package conflict handling > - The benefit is that reruns preserve operator work unless the caller explicitly requests replacement ## Linked Issues or Issue Description **What existing behavior does this improve?** This change improves agent skill synchronization and company package import. **Subsystem affected** This is a cross-cutting change across the shared contracts, server, CLI, and UI. **Current behavior** Agent skill synchronization replaces the full desired skill set from a modeless request. Package import replaces a conflicting skill when the caller does not select a conflict mode. **Proposed behavior** Agent skill synchronization requires `add`, `remove`, or `replace`. Package import skips conflicts by default. Each imported skill reports whether it was created, renamed, replaced, or skipped. **Reason and benefit** Setup and import reruns must preserve operator edits by default. Explicit destructive modes make data loss less likely and make each outcome inspectable. **Breaking changes** Callers of the agent skill sync API must now send `mode`. Callers that need the former behavior must send `replace`. Package import now uses `skip` when `onConflict` is absent. ## What Changed - Added required `add`, `remove`, and `replace` modes to the shared agent skill sync contract. - Added actionable `422` validation for missing or invalid modes. - Updated first-party UI and CLI callers with explicit modes. - Changed package skill conflict handling to use `skip` by default. - Kept plugin-owned and built-in stock skill imports on explicit `replace`. - Added created, renamed, replaced, and skipped results to company imports. - Added regression coverage for merge modes and package conflict outcomes. ## Verification - `pnpm check:token-gates` - `pnpm -r typecheck` - `pnpm build` - `pnpm test:run:serialized` (128 suites passed) - `pnpm --filter @paperclipai/skills-catalog test` (20 tests passed) - Focused agent skill route, company skill service, portability, CLI, and UI tests passed. - GitHub CI passed build, typecheck, canary, all general and serialized test shards, all browser shards, policy, security, and final verification on commit `2cfbb3e4c5`. - Greptile reviewed the latest commit at 5/5 with zero unresolved threads. ## Risks - This change intentionally rejects modeless agent skill sync requests. - The safe package default can leave an existing skill unchanged where the old default overwrote it. - All first-party callers now select a mode. Regression tests cover each outcome. > 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 `gpt-5.6-sol` through Codex. The runtime used agentic reasoning, tool use, code execution, and repository editing. The runtime did not expose the context window size. ## 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 searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
153 lines
4.4 KiB
Markdown
153 lines
4.4 KiB
Markdown
---
|
|
title: Control-Plane Commands
|
|
summary: Issue, agent, approval, and dashboard commands
|
|
---
|
|
|
|
Client-side commands for managing issues, agents, approvals, and more.
|
|
|
|
## Issue Commands
|
|
|
|
```sh
|
|
# List issues
|
|
pnpm paperclipai issue list [--status todo,in_progress] [--assignee-agent-id <id>] [--match text]
|
|
|
|
# Get issue details
|
|
pnpm paperclipai issue get <issue-id-or-identifier>
|
|
|
|
# Create issue
|
|
pnpm paperclipai issue create --title "..." [--description "..."] [--status todo] [--priority high]
|
|
|
|
# Update issue
|
|
pnpm paperclipai issue update <issue-id> [--status in_progress] [--comment "..."]
|
|
|
|
# Add comment
|
|
pnpm paperclipai issue comment <issue-id> --body "..." [--reopen]
|
|
|
|
# Checkout task
|
|
pnpm paperclipai issue checkout <issue-id> --agent-id <agent-id>
|
|
|
|
# Release task
|
|
pnpm paperclipai issue release <issue-id>
|
|
```
|
|
|
|
## Company Commands
|
|
|
|
```sh
|
|
pnpm paperclipai company list
|
|
pnpm paperclipai company get <company-id>
|
|
pnpm paperclipai company current [--company-id <company-id>]
|
|
|
|
# Export to portable folder package (writes manifest + markdown files)
|
|
pnpm paperclipai company export <company-id> --out ./exports/acme --include company,agents
|
|
|
|
# Preview import (no writes)
|
|
pnpm paperclipai company import \
|
|
<owner>/<repo>/<path> \
|
|
--target existing \
|
|
--company-id <company-id> \
|
|
--ref main \
|
|
--collision rename \
|
|
--dry-run
|
|
|
|
# Apply import
|
|
pnpm paperclipai company import \
|
|
./exports/acme \
|
|
--target new \
|
|
--new-company-name "Acme Imported" \
|
|
--include company,agents
|
|
```
|
|
|
|
With agent authentication, use `company list` or `company current` to resolve
|
|
the scoped company. `company list` first tries the board-wide list; if that is
|
|
forbidden, it falls back to `--company-id`, `PAPERCLIP_COMPANY_ID`, context, or
|
|
`/api/agents/me` and returns only that scoped company. `company create` requires
|
|
board/instance-admin authentication because it is an instance-wide setup
|
|
command.
|
|
|
|
## Agent Commands
|
|
|
|
```sh
|
|
pnpm paperclipai agent list
|
|
pnpm paperclipai agent get <agent-id>
|
|
```
|
|
|
|
## Skills Commands
|
|
|
|
```sh
|
|
# Browse app-shipped catalog skills without changing company state
|
|
pnpm paperclipai skills browse [--kind bundled|optional] [--category software-development] [--query github]
|
|
pnpm paperclipai skills search "pull request" [--json]
|
|
|
|
# Inspect catalog metadata and file inventory before install
|
|
pnpm paperclipai skills inspect github-pr-workflow
|
|
|
|
# Install a catalog skill into the company skill library
|
|
# This does not attach the skill to any agent.
|
|
pnpm paperclipai skills install github-pr-workflow --company-id <company-id>
|
|
pnpm paperclipai skills install github-pr-workflow --as pr-flow --force --company-id <company-id>
|
|
|
|
# External sources still use import instead of catalog install
|
|
pnpm paperclipai skills import ./skills/my-skill --company-id <company-id>
|
|
pnpm paperclipai skills import owner/repo/path/to/skill --company-id <company-id>
|
|
|
|
# Attach desired company skills to an agent after install/import
|
|
pnpm paperclipai skills agent sync <agent-id> --skill github-pr-workflow --mode add --company-id <company-id>
|
|
```
|
|
|
|
## Approval Commands
|
|
|
|
```sh
|
|
# List approvals
|
|
pnpm paperclipai approval list [--status pending]
|
|
|
|
# Get approval
|
|
pnpm paperclipai approval get <approval-id>
|
|
|
|
# Create approval
|
|
pnpm paperclipai approval create --type hire_agent --payload '{"name":"..."}' [--issue-ids <id1,id2>]
|
|
|
|
# Approve
|
|
pnpm paperclipai approval approve <approval-id> [--decision-note "..."]
|
|
|
|
# Reject
|
|
pnpm paperclipai approval reject <approval-id> [--decision-note "..."]
|
|
|
|
# Request revision
|
|
pnpm paperclipai approval request-revision <approval-id> [--decision-note "..."]
|
|
|
|
# Resubmit
|
|
pnpm paperclipai approval resubmit <approval-id> [--payload '{"..."}']
|
|
|
|
# Comment
|
|
pnpm paperclipai approval comment <approval-id> --body "..."
|
|
```
|
|
|
|
## Activity Commands
|
|
|
|
```sh
|
|
pnpm paperclipai activity list [--agent-id <id>] [--entity-type issue] [--entity-id <id>]
|
|
```
|
|
|
|
## Dashboard
|
|
|
|
```sh
|
|
pnpm paperclipai dashboard get
|
|
```
|
|
|
|
## Instance Settings
|
|
|
|
```sh
|
|
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 '{...}'
|
|
```
|
|
|
|
Experimental features are opt-in and are provided without compatibility guarantees. They may break, change, or be removed at any time. Use them at your own risk.
|
|
|
|
## Heartbeat
|
|
|
|
```sh
|
|
pnpm paperclipai heartbeat run --agent-id <agent-id> [--api-base http://localhost:3100]
|
|
```
|