Installation

Get Raiken up and running in your project with these installation options. Raiken provides multiple deployment methods to fit your development workflow.

Prerequisites

Before installing Raiken, ensure you have:

• Node.js 16.x or later - Download Node.js
• npm or yarn package manager
• Git for cloning repositories
• A modern web browser (Chrome, Firefox, Safari, or Edge)

Installation Methods

Option 1: CLI Installation (Recommended)

Install the Raiken CLI globally:

# Install globally
npm install -g @raiken/cli

# Navigate to your project
cd your-project

# Initialize Raiken
raiken init

# Start Raiken
raiken start

This will:

• Install the Raiken CLI globally
• Set up Playwright configuration and test directories
• Start the Raiken web interface at http://localhost:3460
• Enable all testing and AI features
• Create project-specific configuration files

Option 2: Web Application Access

Access Raiken directly through the hosted web application without any local setup:

# No installation required - simply visit:
# http://84.46.245.248:3000/tests/editor

# Access the test editor interface directly
# All testing and AI features available immediately
# No configuration files or API keys needed

Option 3: NPX Usage

You can also use npx to run Raiken without global installation:

# Navigate to your project
cd your-project

# Run without installation
npx @raiken/cli start

# Or initialize first
npx @raiken/cli init
npx @raiken/cli start

Environment Setup

API Key Configuration

Raiken uses OpenRouter for AI-powered test generation. Get your API key:

1. Sign up at OpenRouter
2. Generate an API key in your dashboard
3. Configure the key:

Global CLI Installation:

# Set API key in environment variable
export OPENROUTER_API_KEY=your_api_key_here

Local Installation:

Create a .env.local file in your project root:

OPENROUTER_API_KEY=your_api_key_here

Project Configuration

Raiken automatically detects most project configurations, but you can customize settings:

# Generate config file
raiken init

# Edit configuration file manually
nano raiken.config.js

This creates an raiken.config.js file:

module.exports = {
  // Test directory
  testDir: './tests',
  
  // Playwright configuration
  playwright: {
    use: {
      baseURL: 'http://localhost:3000',
      headless: false,
    },
  },
  
  // AI configuration
  ai: {
    model: 'gpt-4',
    temperature: 0.1,
  },
  
  // Bridge configuration
  bridge: {
    port: 3001,
    enabled: true,
  },
}

Verification

After installation, verify everything works:

1. Check CLI installation:

   raiken --version
   raiken --help
   

2. Test project detection:

   cd your-project
   raiken info
   

3. Start Raiken:

   raiken start
   

4. Open the interface at http://localhost:3460

5. Create your first test using the AI test generator

Troubleshooting

Common Issues

Permission Errors (macOS/Linux)

# Fix npm permissions
sudo chown -R $(whoami) ~/.npm

# Alternative: use nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install node

Port Conflicts

# Use different port
raiken start --port 3001

# Kill process using default port
lsof -ti:3000 | xargs kill -9

API Key Issues

# Verify API key is set
echo $OPENROUTER_API_KEY

# Reset configuration by deleting config file
rm raiken.config.js

Windows Installation

# Use PowerShell as Administrator
npm install -g @raiken/cli --force

# If you encounter issues, try:
npm cache clean --force
npm install -g @raiken/cli

Getting Help

If you encounter issues:

1. Check the console output when running raiken start

2. Check project info:

   raiken info
   

3. Search existing issues: GitHub Issues

4. Join the community: GitHub Discussions

Next Steps

Now that Raiken is installed:

• Configuration Guide - Customize your setup
• Quick Start - Create your first test
• Writing Tests - Learn testing best practices
• Examples - See real-world test examples

---

Ready to create your first test? Continue to the Quick Start Guide.