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

# Introduction

> Griffin is an open-source API monitoring platform for production

Griffin is an open-source platform for writing API monitors in TypeScript and running them continuously against your production APIs. Think of it as **monitors that never stop running** — catching issues before your users do.

## What Griffin does

* **Write monitors in TypeScript** — Use a type-safe DSL to define API checks with full IDE support
* **Run continuously** — Schedule monitors to run every minute, hour, or day
* **Monitor from multiple locations** — Execute monitors from different regions to catch geographic issues
* **Get notified** — Receive alerts via Slack, email, or webhooks when monitors fail
* **Track metrics** — View success rates, latency percentiles, and uptime over time

## How it works

```mermaid theme={null}
flowchart LR
    A["__griffin__/\nmonitor files"] --> B["Griffin CLI"]
    B -->|plan & apply| C["Griffin Hub"]
    C -->|scheduled\nexecution| D["Results, metrics,\nand notifications"]
```

1. **Write monitors** in `__griffin__/` directories using the `@griffin-app/griffin` TypeScript DSL
2. **Run locally** with `griffin test` to validate monitors during development
3. **Deploy to the hub** with `griffin apply` to start continuous monitoring
4. **View results** through the platform — runs, metrics, and alerts

## Deployment options

Griffin offers two ways to run:

<CardGroup cols={2}>
  <Card icon="cloud" href="/griffin-cloud/overview" title="Griffin Cloud">
    Managed platform — sign up, connect, and start monitoring. No infrastructure to manage.
  </Card>

  <Card icon="server" href="/griffin-hub/self-hosting" title="Self-hosted">
    Run Griffin Hub on your own infrastructure. Full control over data and execution.
  </Card>
</CardGroup>

## Next steps

<CardGroup cols={2}>
  <Card icon="download" href="/getting-started/installation" title="Installation">
    Install the Griffin CLI.
  </Card>

  <Card icon="rocket" href="/getting-started/quickstart" title="Quickstart">
    Write and run your first test in minutes.
  </Card>
</CardGroup>