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

# Quickstart

> Get OpenWhispr running in under five minutes.

<Steps>
  <Step title="Download">
    Grab the latest release for your platform from the [releases page](https://github.com/OpenWhispr/openwhispr/releases/latest).

    | Platform | Format                                 |
    | -------- | -------------------------------------- |
    | macOS    | `.dmg` (Apple Silicon and Intel)       |
    | Windows  | `.exe` installer                       |
    | Linux    | `.AppImage`, `.deb`, `.rpm`, `.tar.gz` |
  </Step>

  <Step title="Install and launch">
    Open the installer and follow the prompts. On first launch, OpenWhispr walks you through an onboarding wizard.
  </Step>

  <Step title="Choose your processing method">
    * **OpenWhispr Cloud** — sign in with Google, Apple (macOS), Microsoft, or email for instant transcription
    * **Bring your own key** — enter your OpenAI, Groq, or other API key
    * **Local** — download a Whisper or Parakeet model (no internet needed after download)
  </Step>

  <Step title="Grant permissions">
    * **Microphone** — required for voice recording
    * **Accessibility** (macOS) — required for automatic text pasting
    * **Screen recording** (macOS) — needed for meeting audio capture
  </Step>

  <Step title="Start dictating">
    Press your hotkey (Globe/Fn on macOS, Ctrl+Win/Ctrl+Super on Windows and Linux), speak, press again. Your text appears at your cursor.
  </Step>
</Steps>

## Building from source

If you prefer to build from source:

```bash theme={null}
git clone https://github.com/OpenWhispr/openwhispr.git
cd openwhispr
npm install
npm run dev
```

<Note>
  Requires Node.js 24+. See the [contributing guide](/contributing) for build details.
</Note>

## Next steps

* [Set up your AI agent](/guides/agent-mode)
* [Configure meeting transcription](/guides/meeting-transcription)
* [Explore the API](/api/overview)