Docs/Quick Start

Quick Start

Get Claudear running in under 5 minutes

Quick Start

Get Claudear running in under 5 minutes with this quick setup guide.

1. Clone and Install

# 1. Clone the repository
git clone https://github.com/ianborders/claudear.git
cd claudear

# 2. Install the claudear command
pip install claudear

# 3. Create your config
cp .env.example .env

Updating

To update to the latest version:

pip install -U claudear

2. Configure

Claudear auto-detects which providers to enable based on your .env file. Configure one or both:

Option A: Linear Only

# Linear Integration
LINEAR_API_KEY=lin_api_xxxxxxxxxxxxx
LINEAR_WEBHOOK_SECRET=your-webhook-secret
LINEAR_TEAM_ID=ENG  # Your team key from the URL (linear.app/ENG/...)

# Repository
REPO_PATH=/path/to/your/repo

# ngrok (required for Linear webhooks)
NGROK_AUTHTOKEN=your-ngrok-token

Option B: Notion Only

# Notion Integration
NOTION_API_KEY=secret_xxxxxxxxxxxxx
NOTION_DATABASE_ID=your-database-id
NOTION_POLL_INTERVAL=5

# Repository
REPO_PATH=/path/to/your/repo

# GitHub (for PR creation)
GITHUB_TOKEN=ghp_xxxxxxxxxxxxx

Option C: Both Providers

Run Linear and Notion simultaneously. Configure both sets of variables:

# Linear Integration
LINEAR_API_KEY=lin_api_xxxxxxxxxxxxx
LINEAR_WEBHOOK_SECRET=your-webhook-secret
LINEAR_TEAM_ID=ENG

# Notion Integration
NOTION_API_KEY=secret_xxxxxxxxxxxxx
NOTION_DATABASE_ID=abc123def456
NOTION_POLL_INTERVAL=5

# Shared - Single repository for both providers
REPO_PATH=/path/to/your/repo

# GitHub (for PR creation)
GITHUB_TOKEN=ghp_xxxxxxxxxxxxx

# ngrok (required for Linear webhooks)
NGROK_AUTHTOKEN=your-ngrok-token

Claudear auto-detects both providers and runs them simultaneously. Tasks from either Linear or Notion will be picked up and processed.

3. Start Claudear

Run from the cloned repository directory:

cd claudear
claudear

Important: Always run claudear from the cloned repository directory. Configuration is loaded from .env in the current working directory.

What Happens on Startup

Claudear will:

  1. Detect configured providers (Linear, Notion, or both)
  2. For Linear: Start webhook server on port 8000, create ngrok tunnel
  3. For Notion: Start polling at configured interval
  4. Display a banner showing active providers and instances

Example output:

╔════════════════════════════════════════════════════════════════╗
║                          CLAUDEAR                               ║
║             Multi-Provider Development Automation               ║
╠════════════════════════════════════════════════════════════════╣
║  LINEAR PROVIDER                                                ║
║    ✓ ENG → /Users/dev/my-project                               ║
║                                                                 ║
║  NOTION PROVIDER                                                ║
║    ✓ abc123 → /Users/dev/my-project                            ║
║                                                                 ║
║  Max concurrent tasks: 5                                        ║
╚════════════════════════════════════════════════════════════════╝

4. Test It

Testing Linear

  1. Go to your Linear board
  2. Move any issue from Backlog to Todo
  3. Watch Claudear pick up the task!

Testing Notion

  1. Go to your Notion database
  2. Change a page's status to Todo (or your configured todo status)
  3. Wait for the next poll cycle (default: 5 seconds)

You'll see output in your terminal as Claude Code:

  • Creates a worktree for the task
  • Analyzes the requirements
  • Implements the solution
  • Creates a PR

Next Steps

Previous
Introduction
Next
Configuration