02dc46e782
Add structured documentation covering quickstart, architecture, core concepts, API reference, adapter guides, CLI commands, deployment options, and operator/developer guides. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1.8 KiB
1.8 KiB
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 doctorwith 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_trustedorauthenticated) - Exposure policy (if authenticated:
privateorpublic) - 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