mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-07 07:23:08 +02:00
## 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>
1.8 KiB
1.8 KiB
title, summary
| title | summary |
|---|---|
| Tailscale Private Access | Run Paperclip with Tailscale-friendly bind presets and connect from other devices |
Use this when you want to access Paperclip over Tailscale (or a private LAN/VPN) instead of only localhost.
1. Start Paperclip in private authenticated mode
pnpm dev --bind tailnet
Recommended behavior:
PAPERCLIP_DEPLOYMENT_MODE=authenticatedPAPERCLIP_DEPLOYMENT_EXPOSURE=privatePAPERCLIP_BIND=tailnet
If you want the old broad private-network behavior instead, use:
pnpm dev --bind lan
Legacy aliases still map to authenticated/private + bind=lan:
pnpm dev --authenticated-private pnpm dev --tailscale-auth
## 2. Find your reachable Tailscale address
From the machine running Paperclip:
```sh
tailscale ip -4
You can also use your Tailscale MagicDNS hostname (for example my-macbook.tailnet.ts.net).
3. Open Paperclip from another device
Use the Tailscale IP or MagicDNS host with the Paperclip port:
http://<tailscale-host-or-ip>:3100
Example:
http://my-macbook.tailnet.ts.net:3100
4. Allow custom private hostnames when needed
If you access Paperclip with a custom private hostname, add it to the allowlist:
pnpm exec paperclipai allowed-hostname my-macbook.tailnet.ts.net
5. Verify the server is reachable
From a remote Tailscale-connected device:
curl http://<tailscale-host-or-ip>:3100/api/health
Expected result:
{"status":"ok"}
Troubleshooting
- Login or redirect errors on a private hostname: add it with
paperclipai allowed-hostname. - App only works on
localhost: make sure you started with--bind lanor--bind tailnetinstead of plainpnpm dev. - Can connect locally but not remotely: verify both devices are on the same Tailscale network and port
3100is reachable.