Skip to content

doc: update README.md for installation procedure #37

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
cch-gh merged 1 commit into from
May 8, 2026
Merged

doc: update README.md for installation procedure #37

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
18 changes: 7 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,12 @@ Pluggable tools with approval workflows. Bundle built-in skills, create custom o

### Prerequisites

- **Node.js 20+** and **pnpm 9+**
- **Docker** (for agent containers, PostgreSQL, and Redis)
- **Docker Desktop** (user-friendly platform for container management)
- [Git](https://git-scm.com/)
- [Node.js 20+](https://nodejs.org/)
- [pnpm 9+](https://pnpm.io/installation) (`npm install -g pnpm`)
- [Docker](https://docs.docker.com/get-docker/) (for agent containers, PostgreSQL, and Redis)
- [Docker Desktop](https://www.docker.com/products/docker-desktop/) (user-friendly platform for container management)
- [Docker Compose](https://docs.docker.com/compose/install/) (included in Docker Desktop)

> **Self-hosting in production?** Skip ahead to [Production Deployment](#production-deployment-first-run) — the installer handles `.env` generation, image builds, and bootstrap for you. The steps below are for local development.

Expand All @@ -136,14 +139,7 @@ Pluggable tools with approval workflows. Bundle built-in skills, create custom o
git clone https://github.com/ClawixAI/clawix.git
cd clawix

# 2. Prepare your environment file
cp .env.example .env
# Edit .env — set at least one AI provider key:
# ANTHROPIC_API_KEY, OPENAI_API_KEY, or ZAI_CODING_API_KEY
# (The installer will guide you through all required values interactively
# if you prefer to skip manual editing)

# 3. Run the interactive installer
# 2. Run the interactive installer
pnpm run install:clawix
```

Expand Down
Loading