Prerequisites

Before installing Orchestre V3, ensure your system meets these requirements and you have the necessary API keys for advanced features.

System Requirements

Required Software

📦

Node.js 18.0.0 or higher

Required

Orchestre is built with modern JavaScript features that require Node.js 18+.

node --version

Should output: v18.0.0 or higher

Download Node.js →

🤖

Claude Code Desktop

Required

Orchestre integrates with Claude Code through the MCP protocol.

Version 0.7.0 or higher recommended for best compatibility.

Download Claude Code →

🔧

Git

Required

Git is essential for cloning the repository and version control.

git --version

Any recent version (2.x or higher) will work

Download Git →

Recommended Software

📝

VS Code or Your Preferred Editor

Optional

While Claude Code handles the AI interactions, you'll want an editor for reviewing code.

Download VS Code →

API Keys

Orchestre leverages multiple AI models for different tasks. You'll need API keys for full functionality:

Gemini API Key

Google Gemini

For Analysis

Used for: Requirements analysis, complexity assessment, and project planning

Model: gemini-2.0-flash-thinking-exp

1. Visit Google AI Studio
2. Click "Create API Key"
3. Copy your API key
4. Save as GEMINI_API_KEY in your environment

💡 Tip: Gemini offers generous free tier limits perfect for getting started.

OpenAI API Key

OpenAI GPT-4

For Reviews

Used for: Multi-perspective code reviews, security analysis, and consensus building

Model: gpt-4o

1. Visit OpenAI Platform
2. Click "Create new secret key"
3. Copy your API key
4. Save as OPENAI_API_KEY in your environment

⚠️ Note: OpenAI API requires a paid account. Ensure you have credits available.

API Key Security

🚨 Security Best Practices

• Never commit API keys to version control
• Use environment variables for local development
• Rotate keys regularly if exposed
• Set usage limits in your API dashboards

Operating System Compatibility

Orchestre works on all major operating systems:

OS	Supported	Notes
macOS	✅ Fully supported	Recommended for best experience
Windows	✅ Fully supported	Use PowerShell or WSL
Linux	✅ Fully supported	All major distributions

Hardware Requirements

Orchestre itself has minimal hardware requirements:

• RAM: 4GB minimum (8GB recommended)
• Storage: 500MB for Orchestre + space for your projects
• CPU: Any modern processor
• Network: Internet connection for AI API calls

Quick Verification Script

Save this as check-prerequisites.js and run with Node.js:

#!/usr/bin/env node

console.log('🔍 Checking Orchestre Prerequisites...\n');

// Check Node.js version
const nodeVersion = process.version;
const majorVersion = parseInt(nodeVersion.split('.')[0].substring(1));
if (majorVersion >= 18) {
  console.log('✅ Node.js:', nodeVersion);
} else {
  console.log('❌ Node.js:', nodeVersion, '(requires v18.0.0 or higher)');
}

// Check Git
const { execSync } = require('child_process');
try {
  const gitVersion = execSync('git --version').toString().trim();
  console.log('✅ Git:', gitVersion);
} catch (e) {
  console.log('❌ Git: Not installed');
}

// Check environment variables
console.log('\n🔑 API Keys:');
if (process.env.GEMINI_API_KEY) {
  console.log('✅ GEMINI_API_KEY: Set');
} else {
  console.log('⚠️  GEMINI_API_KEY: Not set (required for analysis features)');
}

if (process.env.OPENAI_API_KEY) {
  console.log('✅ OPENAI_API_KEY: Set');
} else {
  console.log('⚠️  OPENAI_API_KEY: Not set (required for review features)');
}

console.log('\n📝 Next Steps:');
console.log('1. Install any missing prerequisites');
console.log('2. Set up API keys if needed');
console.log('3. Continue to the installation guide');

Troubleshooting Prerequisites

Node.js Issues

Problem: Node.js version is too old

# Using nvm (recommended)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 20
nvm use 20

Claude Code Not Found

Problem: Claude Code MCP server won't start

• Ensure Claude Code is running
• Check the application logs at ~/Library/Logs/Claude/
• Restart Claude Code after configuration changes

API Key Errors

Problem: "Invalid API key" errors

• Verify keys are correctly copied (no extra spaces)
• Check API dashboard for key status
• Ensure billing is set up (for OpenAI)

Ready to Install?

Once you've verified all prerequisites:

Continue to Installation →