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

# Quick Start

> Get your status page up and running in 5 minutes

## 1. Create Your Status Page

Sign up at [kodostatus.com/signup](https://kodostatus.com/signup) and create your organization. Your status page will be available at:

```
https://kodostatus.com/status/your-slug
```

## 2. Add Services

Add the services and components you want to display on your status page. Navigate to **Dashboard > Services** and click **Add Service**.

```json theme={null}
{
  "name": "API Gateway",
  "description": "Main API service",
  "status": "operational"
}
```

## 3. Get Your API Key

Go to **Dashboard > API** to generate an API key. You'll use this to authenticate API requests.

## 4. Install the CLI

Manage everything from the terminal — and treat your setup as code.

```bash theme={null}
npm install -g kodo-cli
kodo login YOUR_API_KEY

kodo init      # scaffold a kodo.yaml + SDK snippet for your framework
kodo apply     # provision services / monitors / status pages from kodo.yaml
kodo diff      # preview drift vs. remote, like `terraform plan`
```

Watch your platform live — errors and incidents as they happen:

```bash theme={null}
kodo tail                  # stream everything
kodo tail --errors -e production
```

Drop `kodo apply` into CI to keep monitoring in sync with your repo. Full reference: `kodo --help`.

## 5. Create Your First Incident

<Tabs>
  <Tab title="CLI">
    ```bash theme={null}
    kodo incidents create \
      --title "Investigating API Issues" \
      --status investigating \
      --severity major \
      --services "API Gateway"
    ```
  </Tab>

  <Tab title="API">
    ```bash theme={null}
    curl -X POST "https://kodostatus.com/api/v1/incidents" \
      -H "X-API-Key: your_api_key" \
      -H "Content-Type: application/json" \
      -d '{
        "title": "Investigating API Issues",
        "status": "investigating",
        "severity": "major",
        "services": ["API Gateway"]
      }'
    ```
  </Tab>

  <Tab title="Dashboard">
    Navigate to **Dashboard > Incidents** and click **Create Incident**.
  </Tab>
</Tabs>

## 6. Set Up Monitoring

Add uptime monitors to automatically check your endpoints:

```bash theme={null}
kodo monitors create \
  --name "API Health Check" \
  --url "https://api.example.com/health" \
  --interval 300
```

## Next Steps

<CardGroup cols={2}>
  <Card title="Configure Notifications" icon="bell" href="/notifications/channels">
    Set up Slack, Discord, or email alerts
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Explore the full API
  </Card>

  <Card title="Heartbeat Monitoring" icon="heart-pulse" href="/monitoring/heartbeat">
    Monitor background jobs and workers
  </Card>

  <Card title="Beacon SDK" icon="radar" href="/client-tracking/beacon">
    Track client-side errors
  </Card>
</CardGroup>