paperclip/docs/cli/setup-commands.md at f60c1001ec809a6aa898efd1d119d326e52f2216

Files

Dotta f60c1001ec refactor: rename packages to @paperclipai and CLI binary to paperclipai

Rename all workspace packages from @paperclip/* to @paperclipai/* and
the CLI binary from `paperclip` to `paperclipai` in preparation for
npm publishing. Bump CLI version to 0.1.0 and add package metadata
(description, keywords, license, repository, files). Update all
imports, documentation, user-facing messages, and tests accordingly.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-03-03 08:45:26 -06:00

2.0 KiB

Raw Blame History

title, summary

title	summary
Setup Commands	Onboard, run, doctor, and configure

Instance setup and diagnostics commands.

`paperclipai run`

One-command bootstrap and start:

pnpm paperclipai run

Does:

Auto-onboards if config is missing
Runs paperclipai doctor with repair enabled
Starts the server when checks pass

Choose a specific instance:

pnpm paperclipai run --instance dev

`paperclipai onboard`

Interactive first-time setup:

pnpm paperclipai onboard

Prompts for:

Deployment mode (local_trusted or authenticated)
Exposure policy (if authenticated: private or public)
Public URL (if authenticated + public)
Database and secrets configuration

`paperclipai doctor`

Health checks with optional auto-repair:

pnpm paperclipai doctor
pnpm paperclipai doctor --repair

Validates:

Server configuration
Database connectivity
Secrets adapter configuration
Storage configuration
Missing key files

`paperclipai configure`

Update configuration sections:

pnpm paperclipai configure --section server
pnpm paperclipai configure --section secrets
pnpm paperclipai configure --section storage

`paperclipai env`

Show resolved environment configuration:

pnpm paperclipai env

`paperclipai allowed-hostname`

Allow a private hostname for authenticated/private mode:

pnpm paperclipai allowed-hostname my-tailscale-host

Local Storage Paths

Data	Default Path
Config	`~/.paperclip/instances/default/config.json`
Database	`~/.paperclip/instances/default/db`
Logs	`~/.paperclip/instances/default/logs`
Storage	`~/.paperclip/instances/default/data/storage`
Secrets key	`~/.paperclip/instances/default/secrets/master.key`

Override with:

PAPERCLIP_HOME=/custom/home PAPERCLIP_INSTANCE_ID=dev pnpm paperclipai run

Or pass --data-dir directly on any command:

pnpm paperclipai run --data-dir ./tmp/paperclip-dev
pnpm paperclipai doctor --data-dir ./tmp/paperclip-dev

2.0 KiB Raw Blame History

paperclipai run

paperclipai onboard

paperclipai doctor

paperclipai configure

paperclipai env

paperclipai allowed-hostname