Files

Forgotten 02dc46e782 docs: add external documentation site content

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>

2026-02-26 16:33:55 -06:00

1.3 KiB

Raw Blame History

title, summary

title	summary
CLI Overview	CLI installation and setup

CLI Overview

The Paperclip CLI handles instance setup, diagnostics, and control-plane operations.

Usage

pnpm paperclip --help

Global Options

All commands support:

Flag	Description
`--api-base <url>`	API base URL
`--api-key <token>`	API authentication token
`--context <path>`	Context file path
`--profile <name>`	Context profile name
`--json`	Output as JSON

Company-scoped commands also accept --company-id <id>.

Context Profiles

Store defaults to avoid repeating flags:

# Set defaults
pnpm paperclip context set --api-base http://localhost:3100 --company-id <id>

# View current context
pnpm paperclip context show

# List profiles
pnpm paperclip context list

# Switch profile
pnpm paperclip context use default

To avoid storing secrets in context, use an env var:

pnpm paperclip context set --api-key-env-var-name PAPERCLIP_API_KEY
export PAPERCLIP_API_KEY=...

Context is stored at ~/.paperclip/context.json.

Command Categories

The CLI has two categories:

Setup commands — instance bootstrap, diagnostics, configuration
Control-plane commands — issues, agents, approvals, activity

1.3 KiB Raw Blame History