Files

Dotta cabf09e7b1 feat(cli): add --data-dir flag to isolate local state

Add --data-dir option to all CLI commands, allowing users to override
the default ~/.paperclip root for config, context, database, logs, and
storage. Includes preAction hook to auto-derive --config and --context
paths when --data-dir is set. Add unit tests and doc updates.

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

2026-03-02 14:20:37 -06:00

2.0 KiB

Raw Blame History

title, summary

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

Setup Commands

Instance setup and diagnostics commands.

`paperclip run`

One-command bootstrap and start:

pnpm paperclip run

Does:

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

Choose a specific instance:

pnpm paperclip run --instance dev

`paperclip onboard`

Interactive first-time setup:

pnpm paperclip 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

`paperclip doctor`

Health checks with optional auto-repair:

pnpm paperclip doctor
pnpm paperclip doctor --repair

Validates:

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

`paperclip configure`

Update configuration sections:

pnpm paperclip configure --section server
pnpm paperclip configure --section secrets
pnpm paperclip configure --section storage

`paperclip env`

Show resolved environment configuration:

pnpm paperclip env

`paperclip allowed-hostname`

Allow a private hostname for authenticated/private mode:

pnpm paperclip 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 paperclip run

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

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

2.0 KiB Raw Blame History

Setup Commands

paperclip run

paperclip onboard

paperclip doctor

paperclip configure

paperclip env

paperclip allowed-hostname