docs: sync docs and skills updates from backup branch
This commit is contained in:
13
doc/CLI.md
13
doc/CLI.md
@@ -84,8 +84,21 @@ export PAPERCLIP_API_KEY=...
|
||||
```sh
|
||||
pnpm paperclip company list
|
||||
pnpm paperclip company get <company-id>
|
||||
pnpm paperclip company delete <company-id-or-prefix> --yes --confirm <same-id-or-prefix>
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
```sh
|
||||
pnpm paperclip company delete PAP --yes --confirm PAP
|
||||
pnpm paperclip company delete 5cbe79ee-acb3-4597-896e-7662742593cd --yes --confirm 5cbe79ee-acb3-4597-896e-7662742593cd
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- Deletion is server-gated by `PAPERCLIP_ENABLE_COMPANY_DELETION`.
|
||||
- With agent authentication, company deletion is company-scoped. Use the current company ID/prefix (for example via `--company-id` or `PAPERCLIP_COMPANY_ID`), not another company.
|
||||
|
||||
## Issue Commands
|
||||
|
||||
```sh
|
||||
|
||||
@@ -170,6 +170,19 @@ pnpm secrets:migrate-inline-env # dry run
|
||||
pnpm secrets:migrate-inline-env --apply # apply migration
|
||||
```
|
||||
|
||||
## Company Deletion Toggle
|
||||
|
||||
Company deletion is intended as a dev/debug capability and can be disabled at runtime:
|
||||
|
||||
```sh
|
||||
PAPERCLIP_ENABLE_COMPANY_DELETION=false
|
||||
```
|
||||
|
||||
Default behavior:
|
||||
|
||||
- `local_trusted`: enabled
|
||||
- `authenticated`: disabled
|
||||
|
||||
## CLI Client Operations
|
||||
|
||||
Paperclip CLI now includes client-side control-plane commands in addition to setup commands.
|
||||
|
||||
@@ -809,3 +809,25 @@ V1 is complete only when all criteria are true:
|
||||
- milestones/labels/dependency graph depth beyond V1 minimum
|
||||
- realtime transport optimization (SSE/WebSockets)
|
||||
- public template marketplace integration (ClipHub)
|
||||
|
||||
## 21. Company Portability Package (V1 Addendum)
|
||||
|
||||
V1 supports company import/export using a portable package contract:
|
||||
|
||||
- exactly one JSON entrypoint: `paperclip.manifest.json`
|
||||
- all other package files are markdown with frontmatter
|
||||
- agent convention:
|
||||
- `agents/<slug>/AGENTS.md` (required for V1 export/import)
|
||||
- `agents/<slug>/HEARTBEAT.md` (optional, import accepted)
|
||||
- `agents/<slug>/*.md` (optional, import accepted)
|
||||
|
||||
Export/import behavior in V1:
|
||||
|
||||
- export includes company metadata and/or agents based on selection
|
||||
- export strips environment-specific paths (`cwd`, local instruction file paths)
|
||||
- export never includes secret values; secret requirements are reported
|
||||
- import supports target modes:
|
||||
- create a new company
|
||||
- import into an existing company
|
||||
- import supports collision strategies: `rename`, `skip`, `replace`
|
||||
- import supports preview (dry-run) before apply
|
||||
|
||||
@@ -150,7 +150,7 @@ V1 config fields:
|
||||
- `model` (optional, allow empty = auto)
|
||||
- `autoCreatePr` (optional, default `false`)
|
||||
- `branchName` (optional)
|
||||
- `promptTemplate` / `bootstrapPromptTemplate`
|
||||
- `promptTemplate`
|
||||
- `pollIntervalSec` (optional, default `10`)
|
||||
- `timeoutSec` (optional, default `0`)
|
||||
- `graceSec` (optional, default `20`)
|
||||
@@ -474,4 +474,3 @@ Current process-only cancellation maps are insufficient by themselves for Cursor
|
||||
- [ ] `pnpm -r typecheck`
|
||||
- [ ] `pnpm test:run`
|
||||
- [ ] `pnpm build`
|
||||
|
||||
|
||||
@@ -248,7 +248,6 @@ Runs local `claude` CLI directly.
|
||||
{
|
||||
"cwd": "/absolute/or/relative/path",
|
||||
"promptTemplate": "You are agent {{agent.id}} ...",
|
||||
"bootstrapPromptTemplate": "Initial setup instructions (optional)",
|
||||
"model": "optional-model-id",
|
||||
"maxTurnsPerRun": 80,
|
||||
"dangerouslySkipPermissions": true,
|
||||
@@ -286,7 +285,6 @@ Runs local `codex` CLI directly.
|
||||
{
|
||||
"cwd": "/absolute/or/relative/path",
|
||||
"promptTemplate": "You are agent {{agent.id}} ...",
|
||||
"bootstrapPromptTemplate": "Initial setup instructions (optional)",
|
||||
"model": "optional-model-id",
|
||||
"search": false,
|
||||
"dangerouslyBypassApprovalsAndSandbox": true,
|
||||
@@ -569,14 +567,10 @@ Rules:
|
||||
|
||||
## 10.3 Prompt fields
|
||||
|
||||
1. `bootstrapPromptTemplate`
|
||||
- Used when no session exists.
|
||||
2. `promptTemplate`
|
||||
- Used on every wakeup.
|
||||
1. `promptTemplate`
|
||||
- Used on every wakeup (first run and resumed runs).
|
||||
- Can include run source/reason pills.
|
||||
|
||||
If `bootstrapPromptTemplate` is omitted, `promptTemplate` is used for first run.
|
||||
|
||||
## 10.4 UI requirements
|
||||
|
||||
1. Agent setup/edit form includes prompt editors with pill insertion.
|
||||
|
||||
@@ -64,8 +64,7 @@ For local adapters, set:
|
||||
|
||||
You can set:
|
||||
|
||||
- `bootstrapPromptTemplate`: used for first run/new session
|
||||
- `promptTemplate`: used for subsequent resumed runs
|
||||
- `promptTemplate`: used for every run (first run and resumed sessions)
|
||||
|
||||
Templates support variables like `{{agent.id}}`, `{{agent.name}}`, and run context values.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user