Getting Started

Get up and running with Claude Dojo in under a minute.

Prerequisites

Before you begin, make sure you have:

  • Node.js 18+ installed on your system
  • A valid Claude API key from Anthropic

Quick Start

The fastest way to start using Claude Dojo:

npx claude-dojo

This will:

  1. Download and run the latest version of Claude Dojo
  2. Start a local server on port 3001
  3. Open your default browser to the interface

Skipping permissions

Use the following flag to auto-approves all file writes and shell commands without user interaction

npx claude-dojo --dangerously-skip-permissions

Setting Up Your API Key

Claude Dojo needs your Anthropic API key to communicate with Claude. You can provide it in several ways:

export ANTHROPIC_API_KEY=your-api-key-here
npx claude-dojo

Command Line Argument

npx claude-dojo --api-key your-api-key-here

Configuration File

Create a .claude-dojo.json file in your home directory:

{
  "apiKey": "your-api-key-here"
}

Your First Session

Once Claude Dojo is running:

  1. Type a message in the input field at the bottom
  2. Watch Claude work in the 3D hex-grid interface
  3. Review and approve any file operations or shell commands
  4. Use slash commands like /help for additional functionality

Upgrade Claude Dojo

Upgrade to the latest version using the following command

npx claude-dojo@latest

Next Steps