Devin Foley
fce3b439af
## Thinking Path > - Paperclip is the control plane operators use to manage AI-agent companies. > - Board operators rely on the settings UI and CLI docs to understand which product surfaces are stable to depend on. > - Experimental features already existed in the product, but the operator-facing contract around them was too soft and too fragmented. > - That created a risk that users would enable experiments without being told clearly that they can break, change, or disappear. > - The docs and the in-product settings page both needed the same explicit warning language so the contract is visible at the moment of decision. > - This pull request adds that warning to the board-operator guide, CLI references, and the experimental settings page. > - The benefit is clearer operator expectations without changing the underlying feature flags or rollout behavior. ## Linked Issues or Issue Description No public GitHub issue exists for this docs/polish gap. Problem description: - Board operators could enable experimental features without a clear operator-facing statement that those features are opt-in and come without compatibility guarantees. - The docs site, repo CLI reference, and in-product experimental settings page did not present one consistent warning contract. - This PR closes that gap by documenting the risk explicitly where operators discover and enable those settings. Related public search: - Searched public issues/PRs for related work with `gh search issues --repo paperclipai/paperclip 'experimental features warning'` and `gh search prs --repo paperclipai/paperclip 'experimental features warning'`. - Reviewed open PR #6165 during that search and found it unrelated; it changes experimental auth/routing flags rather than documenting experimental-feature risk. ## What Changed - Added a new board-operator guide at `docs/guides/board-operator/experimental-features.md` that defines the Paperclip contract for experimental features. - Registered that guide in `docs/docs.json` so it appears in the public docs navigation. - Added matching caveat language next to `instance settings:experimental` in `docs/cli/control-plane-commands.md`. - Added the same caveat to `doc/CLI.md` so the repo CLI reference does not drift from the published docs. - Added a single page-level warning banner to `ui/src/pages/InstanceExperimentalSettings.tsx` stating that experimental features are opt-in, carry no compatibility guarantees, and may change, break, or be removed. - Added a targeted UI test in `ui/src/pages/InstanceExperimentalSettings.test.tsx` that asserts exactly one page-level warning renders with the new risk language. ## Verification - `jq empty docs/docs.json` - `git diff --check` - `cd ui && pnpm vitest run src/pages/InstanceExperimentalSettings.test.tsx` - Manual review of the warning contract across: - `docs/guides/board-operator/experimental-features.md` - `docs/cli/control-plane-commands.md` - `doc/CLI.md` - `ui/src/pages/InstanceExperimentalSettings.tsx` UI note: - This is a copy-level warning addition rather than a layout rework. I did not attach before/after screenshots in this PR body. ## Risks - Low risk: this changes operator-facing documentation and warning copy, not feature-flag behavior. - The main failure mode is wording drift across docs and UI in future edits, which is why this PR adds the same contract to all relevant operator-facing surfaces. > I checked `ROADMAP.md` before opening this PR. This is docs/UI polish around an existing experimental surface, not overlapping roadmap-level core feature work. ## Model Used - OpenAI Codex Local using `gpt-5.4` with high reasoning and tool use for coordination, review, docs changes, and PR preparation. - Anthropic Claude Local using `claude-opus-4-8` with high reasoning and tool use for the in-product warning and targeted UI test. ## 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 - [ ] 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 - [ ] All Paperclip CI gates are green - [ ] 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 --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]
|
|
```
|