From c7c96feef77e20bee60be39ad17a664a14a0c3f1 Mon Sep 17 00:00:00 2001 From: Dotta Date: Wed, 4 Mar 2026 08:11:06 -0600 Subject: [PATCH] docs: simplify quickstart to npx onboard, mention create-adapter skill - 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 --- docs/adapters/creating-an-adapter.md | 4 ++++ docs/start/quickstart.md | 21 ++++++--------------- 2 files changed, 10 insertions(+), 15 deletions(-) diff --git a/docs/adapters/creating-an-adapter.md b/docs/adapters/creating-an-adapter.md index 31b1343a..e33b5411 100644 --- a/docs/adapters/creating-an-adapter.md +++ b/docs/adapters/creating-an-adapter.md @@ -5,6 +5,10 @@ summary: Guide to building a custom adapter Build a custom adapter to connect Paperclip to any agent runtime. + +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. + + ## Package Structure ``` diff --git a/docs/start/quickstart.md b/docs/start/quickstart.md index 62dfe6d6..9488b3c7 100644 --- a/docs/start/quickstart.md +++ b/docs/start/quickstart.md @@ -5,24 +5,15 @@ summary: Get Paperclip running in minutes Get Paperclip running locally in under 5 minutes. -## Option 1: Docker Compose (Recommended) - -The fastest way to start. No Node.js install needed. +## Quick Start (Recommended) ```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: - -```sh -ANTHROPIC_API_KEY=sk-... OPENAI_API_KEY=sk-... \ - docker compose -f docker-compose.quickstart.yml up --build -``` - -## Option 2: Local Development +## Local Development 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). -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 pnpm paperclipai run