> ## Documentation Index
> Fetch the complete documentation index at: https://atcyrus.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

Get up and running with Cyrus in 5 minutes or less.

Cyrus offers flexible pricing plans (Pro or Team) and runtime options (self-host or cloud). The Pro plan runs self-hosted only, while the Team plan can run either self-hosted or cloud-hosted.

## Prerequisites

Before starting, ensure you have:

1. **GitHub Account**: Required for authentication and repository integration
2. **Linear Workspace**: You'll need a Linear account and workspace
3. **Claude Code API Key**: Required for AI functionality ([Get one here](https://console.anthropic.com/))

### Step 1: Create your account

Visit [https://app.atcyrus.com/register](https://app.atcyrus.com/register) to begin.

1. **Sign in with GitHub**: Authenticate using your GitHub account
2. **Choose Your Plan**: Select Pro Plan or Team Plan (pricing tier)
3. **Choose Your Runtime**: Pro runs self-hosted; the Team plan can run self-hosted or cloud-hosted (infrastructure)
4. **Complete Stripe Checkout**: Set up your subscription

## Local setup (Self-host runtime)

Please go to [Local Setup Guide](local-setup-pre) and complete the guide before continuing to the onboarding flow below.

## Onboarding wizard

### Step 2: Install GitHub app

You'll be guided through the GitHub App installation process in the onboarding wizard to enable:

* Repository access
* Pull request creation
* GitHub Actions integration

\[insert image here]

<Note>
  After onboarding, add more repositories through the web dashboard at [https://app.atcyrus.com/repos](https://app.atcyrus.com/repos)

  \
  See the [Configuration](configuration.md) guide for detailed options.
</Note>

### Step 2: Connect Linear workspace

1. Authorize Cyrus to access your Linear workspace via OAuth
2. Grant necessary permissions for:
   * Reading issues
   * Creating comments
   * Updating issue status

<Info>
  You may only connect one Linear workspace per account.
</Info>

### Step 3: Select Linear teams

Choose which [Linear teams](https://linear.app/docs/teams) Cyrus should monitor:

* Select one or more teams
* Only issues assigned to Cyrus from these teams will be processed
* You can modify team selections later

### Step 4: Configure Claude

Add your Claude Code API key:

1. Get your API key from [console.anthropic.com](https://console.anthropic.com/)
2. Enter the key in the onboarding wizard

### Step 5: Wizard setup complete

Once all steps are complete, you're ready to go! The onboarding wizard will confirm your setup and show you next steps.

## Post-onboarding

For **Self-host runtime**, Cyrus must stay running on your machine to process issues. See Guide [Here](local-setup-post)

For **Cloud runtime**, Cyrus runs automatically on dedicated infrastructure—no local setup required!

\[add below as tip for config key - JUNAID]

**"Invalid Claude API key"**

* Check your key at [console.anthropic.com](https://console.anthropic.com/)
* Ensure you have sufficient credits

## Getting help

<Card title="Cyrus Community" href="https://discord.com/invite/prrtADHYTt" img="https://mintcdn.com/ceedaraiinc/75NMRUlNh03-gDHX/images/cyrus-f1.png?fit=max&auto=format&n=75NMRUlNh03-gDHX&q=85&s=947d2de0018937ce613572349bc91f06" width="1120" height="928" data-path="images/cyrus-f1.png">
  Join our Discord community for real-time support
</Card>

**Email Support**: Pro and Team Plan subscribers receive priority email and discord support

***