aevgarik/paperclip
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarify quickstart npx usage

Browse Source
This commit is contained in:
dotta
2026-03-20 08:49:46 -05:00
parent 8fc399f511
commit 0f4a5716ea
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/start/quickstart.md
View File

@@ -13,9 +13,19 @@ npx paperclipai onboard --yes
This walks you through setup, configures your environment, and gets Paperclip running. This walks you through setup, configures your environment, and gets Paperclip running.
To start Paperclip again later:
```sh
npx paperclipai run
```
> **Note:** If you used `npx` for setup, always use `npx paperclipai` to run commands. The `pnpm paperclipai` form only works inside a cloned copy of the Paperclip repository (see Local Development below).
## Local Development ## Local Development
Prerequisites: Node.js 20+ and pnpm 9+. For contributors working on Paperclip itself. Prerequisites: Node.js 20+ and pnpm 9+.
Clone the repository, then:
```sh ```sh
pnpm install pnpm install
@@ -26,7 +36,7 @@ This starts the API server and UI at [http://localhost:3100](http://localhost:31
No external database required — Paperclip uses an embedded PostgreSQL instance by default. No external database required — Paperclip uses an embedded PostgreSQL instance by default.
## One-Command Bootstrap When working from the cloned repo, you can also use:
```sh ```sh
pnpm paperclipai run pnpm paperclipai run