From ff883ac79f4b9c96f1c1aa3fbf079260c8039822 Mon Sep 17 00:00:00 2001 From: JAE Date: Wed, 25 Mar 2026 16:46:49 +0000 Subject: [PATCH] docs: add Linux npm permissions guidance and prerequisites section --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 01ca78b..5f0300e 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,20 @@ Think of it as a senior developer pair-programming with you, but it never sleeps ## Quick Start +### Prerequisites + +- **Node.js v18+** (includes npm) — [nodejs.org](https://nodejs.org/) +- An API key from a supported provider (Venice AI, OpenAI, Anthropic, etc.) + +> **Linux users:** Before installing, fix npm global permissions to avoid `EACCES` errors: +> ```bash +> mkdir ~/.npm-global +> npm config set prefix '~/.npm-global' +> echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc +> source ~/.bashrc +> ``` +> This only needs to be done once. Alternatively you can use `sudo npm install -g ...` but the prefix fix is cleaner. + ### Install ```bash