Quick Start

Get up and running with Raiken in under 5 minutes. This guide assumes you have Node.js 18+ installed.

💡 Try Before You Install: Want to see Raiken in action first? We have a live demo environment available. Click the link to explore all features before setting up locally.

Method 1: CLI Tool (Recommended)

The fastest way to start using Raiken with your existing project:

Step 1: Install and Start

# Install globally
npm install -g @raiken/cli

# Navigate to your project
cd my-nextjs-app

# Initialize Raiken
raiken init

# Start Raiken
raiken start

This will:

• Auto-detect your project framework
• Set up necessary configuration files
• Start the web interface at http://localhost:3460

Step 2: Set Up AI

For AI-powered test generation, add your OpenRouter API key to .env.local:

OPENROUTER_API_KEY=your_api_key_here

Get your API key from OpenRouter or see the Configuration Guide for details.

Method 2: Standalone Application

Run Raiken as a standalone web application:

Step 1: Clone and Install

git clone https://github.com/your-username/raiken.git
cd raiken
npm install

Step 2: Configure Environment

Add your OpenRouter API key (same as Method 1 above).

Step 3: Start Development Server

npm run dev

Visit http://localhost:3460 to access Raiken.

Your First Test

Using AI Generation

1. Open the Test Builder - Click "Generate Test" in the right panel
2. Describe Your Test in natural language:

   Test the product search and filtering functionality
   

3. Generate - Raiken will create a complete Playwright test
4. Review and Edit - Use the Monaco editor to refine if needed
5. Save - Tests are automatically saved to your project's test directory

Manual Test Creation

1. Open Test Editor - Click "New Test" in the interface
2. Write Playwright Code using the Monaco editor with TypeScript support
3. Use Real-time DOM - Click elements on the page to get selectors
4. Execute Tests - Run tests directly from the interface

Key Features Overview

🤖 AI-Powered Test Generation

• Natural language to Playwright tests
• Uses Claude 3.5 Sonnet and other advanced models
• Context-aware generation based on your application

🌐 Multi-Browser Testing

• Chromium, Firefox, WebKit support
• Configurable browser settings
• Video recording and screenshots

📝 Advanced Test Editor

• Monaco editor with TypeScript support
• Syntax highlighting and autocomplete
• Real-time error checking

🔄 Local Integration

• Direct file system access via CLI
• Tests saved to your project directory
• Integrates with existing Playwright setup

📊 Rich Reporting

• Detailed test execution results
• Video recordings and screenshots
• AI-powered failure analysis

Common Workflows

Workflow 1: New Feature Testing

# Start Raiken in your project
raiken start

# Navigate to your new feature in browser
# Describe the test in natural language
# Generate and refine the test
# Run test to verify functionality

Workflow 2: Regression Testing

# Generate tests for critical user paths
# Run tests in CI/CD pipeline
# Review reports and fix issues

Workflow 3: Cross-Browser Testing

# Configure multiple browsers in settings
# Run tests across Chromium, Firefox, WebKit
# Compare results and handle browser-specific issues

Configuration Quick Reference

CLI Configuration (raiken.config.json)

{
  "projectType": "nextjs",
  "testDirectory": "e2e",
  "playwrightConfig": "playwright.config.ts",
  "ai": {
    "provider": "openrouter",
    "model": "anthropic/claude-3.5-sonnet"
  }
}

Environment Variables (.env.local)

OPENROUTER_API_KEY=your_api_key_here
OPENROUTER_MODEL=anthropic/claude-3.5-sonnet

Troubleshooting Quick Fixes

Port Already in Use

raiken start --port 4000

Playwright Not Found

npm install -D @playwright/test
npx playwright install

AI Generation Not Working

1. Check your OPENROUTER_API_KEY in .env.local
2. Verify internet connection
3. Restart Raiken: npm run dev

File Permission Issues

chmod -R 755 your-project-directory/

Next Steps

Now that you have Raiken running:

• Configuration - Customize settings for your workflow
• Writing Tests - Learn testing best practices
• AI Test Generation - Master AI-powered testing
• Examples - See real-world test examples

Getting Help

• Documentation: Complete guides in this documentation site
• CLI Help: raiken --help or raiken <command> --help
• GitHub Issues: Report bugs and request features
• Community: Join discussions and get support

---

Ready to dive deeper? Continue with Configuration to customize Raiken for your specific needs.