Installation Methods

Installation Methods

Status: ✅ Complete

Phase: Phase 7 - Integration Features

Last Updated: December 9, 2025

---

Overview

RiceCoder provides multiple installation methods to suit different preferences and environments. Choose from curl script, package managers, Docker, or binary releases. All methods are supported on Windows, macOS, and Linux.

Quick Install

Curl Script (Recommended)

Build and install RiceCoder with a single command:

curl -fsSL https://raw.githubusercontent.com/moabualruz/ricecoder/main/scripts/install | bash

This script:

• Detects your OS and architecture
• Checks prerequisites (Rust, Cargo, Git)
• Updates Rust toolchain
• Builds from source
• Installs to /usr/local/bin or custom prefix
• Adds to PATH automatically
• Verifies installation

Homebrew (macOS/Linux)

Install via Homebrew:

brew install ricecoder

Update to latest version:

brew upgrade ricecoder

Uninstall:

brew uninstall ricecoder

Cargo (Rust)

Install via Cargo:

cargo install ricecoder

Install specific version:

cargo install [email protected]

Update to latest:

cargo install --upgrade ricecoder

Uninstall:

cargo uninstall ricecoder

NPM (Node.js)

Install via NPM:

npm install -g ricecoder

Install specific version:

npm install -g [email protected]

Update to latest:

npm update -g ricecoder

Uninstall:

npm uninstall -g ricecoder

Platform-Specific Installation

Windows

Chocolatey

Install via Chocolatey:

choco install ricecoder

Update:

choco upgrade ricecoder

Scoop

Install via Scoop:

scoop install ricecoder

Update:

scoop update ricecoder

Windows Package Manager

Install via Windows Package Manager:

winget install ricecoder

Update:

winget upgrade ricecoder

Manual Installation

Download and install manually:

1. Download latest release from GitHub Releases
2. Extract to desired location
3. Add to PATH:
   • Right-click "This PC" → Properties
   • Advanced system settings → Environment Variables
   • Add installation directory to PATH
4. Verify installation: rice --version

macOS

Homebrew (Recommended)

brew install ricecoder

MacPorts

sudo port install ricecoder

Manual Installation

1. Download latest release for macOS
2. Extract: tar -xzf ricecoder-*.tar.gz
3. Move to PATH: sudo mv ricecoder /usr/local/bin/
4. Verify: rice --version

Linux

APT (Debian/Ubuntu)

Add repository (via GitHub raw content):

curl -fsSL https://raw.githubusercontent.com/moabualruz/ricecoder/main/scripts/install-apt-key.sh | sudo bash
echo "deb [signed-by=/usr/share/keyrings/ricecoder-archive-keyring.gpg] https://github.com/moabualruz/ricecoder/releases/download/latest stable main" | sudo tee /etc/apt/sources.list.d/ricecoder.list

Install:

sudo apt update
sudo apt install ricecoder

Update:

sudo apt upgrade ricecoder

YUM (RHEL/CentOS/Fedora)

Add repository (via GitHub raw content):

curl -fsSL https://raw.githubusercontent.com/moabualruz/ricecoder/main/scripts/install-yum-repo.sh | sudo bash

Install:

sudo yum install ricecoder

Update:

sudo yum upgrade ricecoder

Pacman (Arch Linux)

Install from AUR:

yay -S ricecoder

Or manually:

git clone https://aur.archlinux.org/ricecoder.git
cd ricecoder
makepkg -si

Manual Installation

1. Download latest release for Linux
2. Extract: tar -xzf ricecoder-*.tar.gz
3. Move to PATH: sudo mv ricecoder /usr/local/bin/
4. Verify: rice --version

Docker Installation

Docker Image

Pull and run Docker image:

docker pull ricecoder/ricecoder:latest
docker run -it ricecoder/ricecoder:latest rice --version

Run with volume mount:

docker run -it -v ~/.ricecoder:/root/.ricecoder ricecoder/ricecoder:latest rice chat

Docker Compose

Create docker-compose.yml:

version: '3.8'

services:
  ricecoder:
    image: ricecoder/ricecoder:latest
    container_name: ricecoder
    volumes:
      - ~/.ricecoder:/root/.ricecoder
      - ./projects:/workspace
    environment:
      - RICECODER_HOME=/root/.ricecoder
      - OPENAI_API_KEY=${OPENAI_API_KEY}
    stdin_open: true
    tty: true
    command: rice chat

Run with Docker Compose:

docker-compose up -d
docker-compose exec ricecoder rice chat

Dockerfile

Create custom Dockerfile:

FROM ricecoder/ricecoder:latest

# Install additional tools
RUN apt-get update && apt-get install -y \
    git \
    curl \
    && rm -rf /var/lib/apt/lists/*

# Set working directory
WORKDIR /workspace

# Set environment variables
ENV RICECODER_HOME=/root/.ricecoder

# Default command
CMD ["rice", "chat"]

Build and run:

docker build -t my-ricecoder .
docker run -it -v ~/.ricecoder:/root/.ricecoder my-ricecoder

Binary Releases

Download Binaries

Download pre-compiled binaries from GitHub Releases:

• ricecoder-x86_64-unknown-linux-gnu - Linux x86_64
• ricecoder-x86_64-apple-darwin - macOS Intel
• ricecoder-aarch64-apple-darwin - macOS ARM64
• ricecoder-x86_64-pc-windows-msvc - Windows x86_64
• ricecoder-aarch64-unknown-linux-gnu - Linux ARM64

Install Binary

Extract and install:

# Linux/macOS
tar -xzf ricecoder-*.tar.gz
sudo mv ricecoder /usr/local/bin/

# Windows (PowerShell)
Expand-Archive ricecoder-*.zip
Move-Item ricecoder.exe "C:\Program Files\ricecoder\"

Verify installation:

rice --version

Build from Source

Using Installation Scripts (Recommended)

Automated build and installation with prerequisite checking:

Linux/macOS:

# Clone repository
git clone https://github.com/moabualruz/ricecoder.git
cd ricecoder

# Make script executable
chmod +x scripts/install.sh

# Run installation script
./scripts/install.sh

# Verify installation
rice --version

Installation Script Options:

# Install to custom prefix
./scripts/install.sh --prefix /usr/local

# Debug build
./scripts/install.sh --debug

# Verbose output
./scripts/install.sh --verbose

Windows (PowerShell):

# Clone repository
git clone https://github.com/moabualruz/ricecoder.git
cd ricecoder

# Run installation script
.\scripts\install.ps1

# Verify installation
rice --version

Installation Script Options:

# Install to custom prefix
.\scripts\install.ps1 -Prefix "C:\Program Files\ricecoder"

# Debug build
.\scripts\install.ps1 -Debug

# Verbose output
.\scripts\install.ps1 -Verbose

Windows (CMD):

# Clone repository
git clone https://github.com/moabualruz/ricecoder.git
cd ricecoder

# Run installation script
scripts\install.bat

# Verify installation
rice --version

Installation Script Features:

• ✅ Automatic OS and architecture detection
• ✅ Prerequisite verification (Rust, Cargo, Git)
• ✅ Automatic Rust toolchain update
• ✅ Configurable build mode (release/debug)
• ✅ Automatic binary installation
• ✅ Configuration file installation
• ✅ Documentation installation
• ✅ Installation verification
• ✅ PATH configuration guidance

Manual Build and Install

For advanced users or custom builds:

Prerequisites:

• Rust 1.70+ (Install Rust)
• Git
• C compiler (gcc/clang)

Clone and Build:

Clone repository:

git clone https://github.com/moabualruz/ricecoder.git
cd ricecoder

Build release binary:

cargo build --release

Binary location: target/release/ricecoder

Install to PATH:

# Linux/macOS
sudo cp target/release/ricecoder /usr/local/bin/

# Windows (PowerShell)
Copy-Item target/release/ricecoder.exe "C:\Program Files\ricecoder\"

Verify installation:

rice --version

Verification

Verify Installation

Check installation:

rice --version
# Output: ricecoder 0.1.7

rice --help
# Output: RiceCoder - Terminal-first coding assistant

Verify Functionality

Test basic functionality:

# Initialize a project
rice init

# Start interactive chat
rice chat

# Generate code
rice gen --help

Uninstallation

Homebrew

brew uninstall ricecoder

Cargo

cargo uninstall ricecoder

NPM

npm uninstall -g ricecoder

Chocolatey

choco uninstall ricecoder

Scoop

scoop uninstall ricecoder

Manual Removal

Remove binary:

# Linux/macOS
sudo rm /usr/local/bin/ricecoder

# Windows
Remove-Item "C:\Program Files\ricecoder\ricecoder.exe"

Remove configuration:

# Remove all RiceCoder data
rm -rf ~/.ricecoder

# Windows
Remove-Item -Recurse -Force $env:APPDATA\.ricecoder

Troubleshooting

Issue: Command not found

Solution: Ensure RiceCoder is in PATH:

# Check if rice is in PATH
which rice

# If not found, add to PATH manually
export PATH="/usr/local/bin:$PATH"

# Or reinstall with correct location

Issue: Permission denied

Solution: Fix file permissions:

# Make binary executable
chmod +x /usr/local/bin/ricecoder

# Or reinstall with sudo
sudo cargo install ricecoder

Issue: Version mismatch

Solution: Update to latest version:

# Using Homebrew
brew upgrade ricecoder

# Using Cargo
cargo install --upgrade ricecoder

# Using NPM
npm update -g ricecoder

# Using curl script (from GitHub)
curl -fsSL https://raw.githubusercontent.com/moabualruz/ricecoder/main/scripts/install | bash

Issue: Docker image not found

Solution: Pull latest image:

docker pull ricecoder/ricecoder:latest
docker run -it ricecoder/ricecoder:latest rice --version

Platform Support

Platform	Status	Installation Methods
Linux x86_64	✅	Curl, APT, YUM, Pacman, Cargo, NPM, Docker, Binary
Linux ARM64	✅	Curl, Cargo, NPM, Docker, Binary
macOS Intel	✅	Curl, Homebrew, MacPorts, Cargo, NPM, Docker, Binary
macOS ARM64	✅	Curl, Homebrew, MacPorts, Cargo, NPM, Docker, Binary
Windows x86_64	✅	Curl, Chocolatey, Scoop, WinGet, Cargo, NPM, Docker, Binary
Windows ARM64	✅	Cargo, NPM, Docker, Binary

Performance

• Curl Installation: < 30 seconds
• Homebrew Installation: < 1 minute
• Cargo Installation: 2-5 minutes (first time)
• Docker Pull: < 1 minute
• Binary Extraction: < 5 seconds

See Also

• Quick Start Guide - Get started after installation
• Configuration Guide - Configure RiceCoder
• Troubleshooting Guide - Solve common issues
• Architecture Overview - System architecture

---

Last updated: December 9, 2025