📦 Installation Guide

Get started with Hanoi Rainbow in minutes.

⚙️ What You Need

Before installing, make sure you have:

Requirement Description
Operating System Linux, macOS, or Windows (PowerShell supported)
AI Assistant Claude Code, GitHub Copilot, Gemini CLI, or CodeBuddy CLI
Package Manager uv
Python Version 3.11 or higher
Version Control Git

🚀 Installation Options

Option 1: Create a New Project

The easiest way to start:

uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init <PROJECT_NAME>

Option 2: Initialize in Current Directory

Already have a project folder?

# Method 1: Using dot notation
uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init .

# Method 2: Using --here flag
uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init --here

🤖 Choose Your AI Agent

Specify which AI assistant to use:

# Claude Code
uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init <project_name> --ai claude

# Gemini CLI
uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init <project_name> --ai gemini

# GitHub Copilot
uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init <project_name> --ai copilot

# CodeBuddy CLI
uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init <project_name> --ai codebuddy

🔧 Choose Script Type (Bash or PowerShell)

All automation scripts come in both formats:

Default behavior:

  • 🪟 Windows → PowerShell (.ps1)
  • 🐧 Linux/macOS → Bash (.sh)
  • 💬 Interactive mode → You'll be asked

Force a specific type:

# Force Bash scripts
uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init <project_name> --script sh

# Force PowerShell scripts
uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init <project_name> --script ps

⚡ Skip Tool Checks (Optional)

Want to set up without checking if AI tools are installed?

uvx --from git+https://github.com/dauquangthanh/hanoi-rainbow.git rainbow init <project_name> --ai claude --ignore-agent-tools

Use this when: You're setting up on a different machine or want to configure tools later.

✅ Verify Installation

After setup, check that everything works:

1. Check for Slash Commands

Your AI agent should show these core commands:

Core Workflow:

Command Purpose
/rainbow.regulate Set project principles
/rainbow.specify Create specifications
/rainbow.design Generate implementation plans
/rainbow.taskify Break down into actionable tasks
/rainbow.implement Execute the plan

2. Check Script Files

The .rainbow/scripts directory should contain both:

  • ✅ Bash scripts (.sh) for Linux/macOS
  • ✅ PowerShell scripts (.ps1) for Windows

🛠️ Troubleshooting

Git Authentication Issues on Linux

Having trouble with Git authentication? Install Git Credential Manager:

#!/usr/bin/env bash
set -e

echo "⬇️ Downloading Git Credential Manager v2.6.1..."
wget https://github.com/git-ecosystem/git-credential-manager/releases/download/v2.6.1/gcm-linux_amd64.2.6.1.deb

echo "📦 Installing..."
sudo dpkg -i gcm-linux_amd64.2.6.1.deb

echo "⚙️ Configuring Git..."
git config --global credential.helper manager

echo "🧹 Cleaning up..."
rm gcm-linux_amd64.2.6.1.deb

echo "✅ Done! Git Credential Manager is ready."

Need More Help?

Edit this page