mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-11 23:36:51 +02:00
Nicky LeachandPaperclip
5ca7b4c1fe
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Paperclip provides CLI guidance to agents and operators through documentation and runtime messages. > - Content-bearing `pnpm paperclipai` examples send arguments through a shell. > - Shell evaluation can execute command substitutions in untrusted argument content. > - Runtime hostname guidance can also place request-derived content inside a shell command. > - This pull request uses `npx paperclipai` for content-bearing guidance and uses a static hostname placeholder. > - The benefit is safer copy-paste guidance for agents and operators. ## Linked Issues or Issue Description **Issue type** Incorrect information **Where is the issue?** CLI guidance in `doc/CLI.md`, `skills/paperclip/SKILL.md`, documentation, and runtime-generated hints. **What's wrong?** Content-bearing `pnpm paperclipai` commands can pass argument text through `/bin/sh`. Shell command substitution in an argument can execute before the CLI receives the value. **Suggested fix** Use `npx paperclipai` for content-bearing commands. Use a static `<host>` placeholder when runtime guidance displays the allowed-hostname command. ## What Changed - Replace content-bearing `pnpm paperclipai` examples with `npx paperclipai` across the documentation and agent-facing guidance. - Update runtime-generated CLI hints to use a static `<host>` placeholder. - Add safety notes to `doc/CLI.md` and `skills/paperclip/SKILL.md`. - Add scans and regression tests for unsafe invocation and hostile hostname headers. - Keep fixed lifecycle commands and `pnpm --filter @paperclipai/*` build commands unchanged. ## Verification - Run `tsc --noEmit` for the changed server files. - Run `cli-invocation-safety.test.ts`. - Run `private-hostname-guard.test.ts`. - Confirm that hostile hostname headers do not enter shown shell commands. - Confirm that the three commits contain the required Paperclip co-author trailer. ## Risks - This change updates documentation and diagnostic text across many surfaces. - Fixed lifecycle and setup commands remain unchanged. - The tests fail if content-bearing `pnpm paperclipai` guidance returns. - The change does not alter the CLI argument parser. ## Model Used OpenAI Codex, GPT-5, tool use, code execution, and repository review assistance. ## 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>
89 lines
2.1 KiB
Markdown
89 lines
2.1 KiB
Markdown
---
|
|
title: Deployment Modes
|
|
summary: local_trusted vs authenticated (private/public)
|
|
---
|
|
|
|
Paperclip supports two runtime modes with different security profiles. Reachability is configured separately with `bind`.
|
|
|
|
## `local_trusted`
|
|
|
|
The default mode. Optimized for single-operator local use.
|
|
|
|
- **Host binding**: loopback only (localhost)
|
|
- **Bind**: `loopback`
|
|
- **Authentication**: no login required
|
|
- **Use case**: local development, solo experimentation
|
|
- **Board identity**: auto-created local board user
|
|
|
|
```sh
|
|
# Set during onboard
|
|
pnpm paperclipai onboard
|
|
# Choose "local_trusted"
|
|
```
|
|
|
|
## `authenticated`
|
|
|
|
Login required. Supports two exposure policies.
|
|
|
|
### `authenticated` + `private`
|
|
|
|
For private network access (Tailscale, VPN, LAN).
|
|
|
|
- **Authentication**: login required via Better Auth
|
|
- **URL handling**: auto base URL mode (lower friction)
|
|
- **Host trust**: private-host trust policy required
|
|
- **Bind**: choose `loopback`, `lan`, `tailnet`, or `custom`
|
|
|
|
```sh
|
|
pnpm paperclipai onboard
|
|
# Choose "authenticated" -> "private"
|
|
```
|
|
|
|
Allow custom Tailscale hostnames:
|
|
|
|
```sh
|
|
pnpm exec paperclipai allowed-hostname my-machine
|
|
```
|
|
|
|
### `authenticated` + `public`
|
|
|
|
For internet-facing deployment.
|
|
|
|
- **Authentication**: login required
|
|
- **URL**: explicit public URL required
|
|
- **Security**: stricter deployment checks in doctor
|
|
- **Bind**: usually `loopback` behind a reverse proxy; `lan/custom` is advanced
|
|
|
|
```sh
|
|
pnpm paperclipai onboard
|
|
# Choose "authenticated" -> "public"
|
|
```
|
|
|
|
## Board Claim Flow
|
|
|
|
When migrating from `local_trusted` to `authenticated`, Paperclip emits a one-time claim URL at startup:
|
|
|
|
```
|
|
/board-claim/<token>?code=<code>
|
|
```
|
|
|
|
A signed-in user visits this URL to claim board ownership. This:
|
|
|
|
- Promotes the current user to instance admin
|
|
- Demotes the auto-created local board admin
|
|
- Ensures active company membership for the claiming user
|
|
|
|
## Changing Modes
|
|
|
|
Update the deployment mode:
|
|
|
|
```sh
|
|
pnpm paperclipai configure --section server
|
|
```
|
|
|
|
Runtime override via environment variable:
|
|
|
|
```sh
|
|
PAPERCLIP_DEPLOYMENT_MODE=authenticated PAPERCLIP_BIND=lan pnpm paperclipai run
|
|
```
|