09d2ef1a37
- Restored docs/ directory that was accidentally deleted by `git add -A` in the v0.2.3 release script - Replaced generic "P" favicon with actual paperclip icon using brand primary color (#2563EB) - Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark) - Updated docs.json with logo configuration for dark/light mode - Fixed release.sh to stage only release-related files instead of `git add -A` to prevent sweeping unrelated changes into release commits Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2.2 KiB
2.2 KiB
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 doctorwith 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
First prompt:
Quickstart(recommended): local defaults (embedded database, no LLM provider, local disk storage, default secrets)Advanced setup: full interactive configuration
Start immediately after onboarding:
pnpm paperclipai onboard --run
Non-interactive defaults + immediate start (opens browser on server listen):
pnpm paperclipai onboard --yes
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