hanh.tonguyen/paperclip
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: simplify quickstart to npx onboard, mention create-adapter skill

Browse Source 
- Remove Docker option from quickstart, make `npx paperclipai onboard --yes` the recommended path
- Add tip about `create-agent-adapter` skill in the creating-an-adapter guide

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Dotta
2026-03-04 08:11:06 -06:00
parent 7e387a1883
commit c7c96feef7
2 changed files with 10 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/adapters/creating-an-adapter.md
View File

@@ -5,6 +5,10 @@ summary: Guide to building a custom adapter
Build a custom adapter to connect Paperclip to any agent runtime. Build a custom adapter to connect Paperclip to any agent runtime.
<Tip>
If you're using Claude Code, the `create-agent-adapter` skill can guide you through the full adapter creation process interactively. Just ask Claude to create a new adapter and it will walk you through each step.
</Tip>
## Package Structure ## Package Structure
``` ```

21
docs/start/quickstart.md
View File

@@ -5,24 +5,15 @@ summary: Get Paperclip running in minutes
Get Paperclip running locally in under 5 minutes. Get Paperclip running locally in under 5 minutes.
## Option 1: Docker Compose (Recommended) ## Quick Start (Recommended)
The fastest way to start. No Node.js install needed.
```sh ```sh
docker compose -f docker-compose.quickstart.yml up --build npx paperclipai onboard --yes
``` ```
Open [http://localhost:3100](http://localhost:3100). That's it. This walks you through setup, configures your environment, and gets Paperclip running.
The Docker image includes Claude Code CLI and Codex CLI pre-installed for local adapter runs. Pass API keys to enable them: ## Local Development
```sh
ANTHROPIC_API_KEY=sk-... OPENAI_API_KEY=sk-... \
docker compose -f docker-compose.quickstart.yml up --build
```
## Option 2: Local Development
Prerequisites: Node.js 20+ and pnpm 9+. Prerequisites: Node.js 20+ and pnpm 9+.
@@ -33,9 +24,9 @@ pnpm dev
This starts the API server and UI at [http://localhost:3100](http://localhost:3100). This starts the API server and UI at [http://localhost:3100](http://localhost:3100).
No Docker or external database required — Paperclip uses an embedded PostgreSQL instance by default. No external database required — Paperclip uses an embedded PostgreSQL instance by default.
## Option 3: One-Command Bootstrap ## One-Command Bootstrap
```sh ```sh
pnpm paperclipai run pnpm paperclipai run