Skip to content

docs: add Node setup before npm install #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0xmrpeter merged 1 commit into from
May 4, 2026
Merged

docs: add Node setup before npm install #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 25 additions & 1 deletion docs/gitbook/getting-started/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
```
Expand Down