Installation

This guide covers all supported installation methods for ReArch, including local development, Docker, and cloud deployments.

System Requirements

Requirement	Minimum	Recommended
CPU	2 cores	4+ cores
RAM	4 GB	8+ GB
Disk	2 GB free	10+ GB free
Node.js	v18.0	v20+ LTS
OS	macOS, Linux, Windows (WSL2)	macOS or Linux

Installation Methods

Using Bun (Recommended)

Bun is the recommended package manager for ReArch projects due to its speed and compatibility.

# Install Bun if you haven't already
curl -fsSL https://bun.sh/install | bash

# Install ReArch CLI globally
bun install -g @rearch/cli

# Verify installation
rearch --version

Using npm

npm install -g @rearch/cli
rearch --version

Using Docker

For containerized environments, use the official Docker image:

docker pull rearch/rearch:latest
docker run -it --rm -v $(pwd):/app rearch/rearch:latest init my-project

Docker Compose

Create a docker-compose.yml file:

version: '3.8'
services:
  rearch:
    image: rearch/rearch:latest
    ports:
      - "3000:3000"
    volumes:
      - ./src:/app/src
    environment:
      - NODE_ENV=development
      - REARCH_API_KEY=${REARCH_API_KEY}

Then run:

docker compose up -d

Post-Installation

After installing, run the setup wizard to configure your environment:

rearch setup

This will guide you through:

Authenticating with your ReArch account
Selecting a default workspace
Configuring local preferences
Setting up editor integrations

Troubleshooting

Common Issues

Permission denied errors on macOS/Linux:

sudo chown -R $(whoami) /usr/local/lib/node_modules

Bun not found after installation:

Add Bun to your PATH by adding this to your shell profile (~/.bashrc, ~/.zshrc, etc.):

export BUN_INSTALL="$HOME/.bun"
export PATH="$BUN_INSTALL/bin:$PATH"

Docker socket permission denied:

sudo usermod -aG docker $USER
newgrp docker