From a744d87f084fe4d9bb444b666e9776433ccfc0f3 Mon Sep 17 00:00:00 2001 From: zerone0x Date: Wed, 29 Apr 2026 11:11:04 +0000 Subject: [PATCH] docs: add node setup before npm install Fixes #94 Co-Authored-By: Hermes Agent --- README.md | 12 +++++++++- docs/gitbook/getting-started/quick-start.md | 26 ++++++++++++++++++++- 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b53ada3..272d8f9b 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,17 @@ powershell -c "irm https://raw.githubusercontent.com/Open-ACP/OpenACP/main/scrip ### Manual install via npm -If you already have Node.js 20+ installed: +If you do not have Node.js yet, install it first. For example, on macOS or Linux with `nvm`: + +```bash +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash +export NVM_DIR="$HOME/.nvm" +[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" +nvm install --lts +nvm use --lts +``` + +Then install OpenACP with npm: ```bash npm install -g @openacp/cli diff --git a/docs/gitbook/getting-started/quick-start.md b/docs/gitbook/getting-started/quick-start.md index ece28252..cb77d87d 100644 --- a/docs/gitbook/getting-started/quick-start.md +++ b/docs/gitbook/getting-started/quick-start.md @@ -4,7 +4,7 @@ This guide gets you from zero to chatting with an AI agent in your Telegram (or ## What you'll need -- **Node.js 20 or later** — check with `node --version` +- **Node.js 20 or later** — check with `node --version`. If Node.js is not installed, use the installer below or install it with a version manager such as `nvm`. - **A bot token** for your chat platform: - Telegram: create one via [@BotFather](https://t.me/BotFather) - Discord: create one in the [Discord Developer Portal](https://discord.com/developers/applications) @@ -15,6 +15,30 @@ This guide gets you from zero to chatting with an AI agent in your Telegram (or ## Step 1: Install OpenACP +On macOS or Linux, run the installer: + +```bash +curl -fsSL https://raw.githubusercontent.com/Open-ACP/OpenACP/main/scripts/install.sh | bash +``` + +On Windows, run this in PowerShell: + +```powershell +powershell -c "irm https://raw.githubusercontent.com/Open-ACP/OpenACP/main/scripts/install.ps1 | iex" +``` + +If you prefer a manual npm install and do not have Node.js yet, install Node.js first. For example, on macOS or Linux with `nvm`: + +```bash +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash +export NVM_DIR="$HOME/.nvm" +[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" +nvm install --lts +nvm use --lts +``` + +Then install OpenACP: + ```bash npm install -g @openacp/cli ```