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

# Quickstart

> Install Rainy MaTE BETA 1 on macOS and run your first workspace task.

<Warning>
  `BETA 1` is currently `macOS-only`. Windows and Linux support is planned for a near-future release.
</Warning>

## Before you begin

You need:

* macOS desktop access.
* One provider API key that your deployment supports.
* A local folder where Rainy MaTE can read and write files.

Get platform/user keys from the dashboard: [app.rainy-mate.com](https://app.rainy-mate.com).

## Install the desktop app

<Steps>
  <Step title="Download the installer">
    Open the [Rainy MaTE releases page](https://github.com/ferxalbs/rainy-mate/releases) and download the latest macOS package.
  </Step>

  <Step title="Install Rainy MaTE">
    Complete installation and try to open the app.
  </Step>

  <Step title="Allow app in macOS settings if blocked">
    If macOS blocks the app, follow `/users/install-desktop` to allow the app from `System Settings -> Privacy & Security`.
  </Step>

  <Step title="Grant folder access when prompted">
    The app needs explicit workspace access for file operations.
  </Step>
</Steps>

## Configure an AI provider

<Steps>
  <Step title="Open provider settings">
    Go to `Settings -> Models` in the left sidebar.
  </Step>

  <Step title="Add your provider key">
    Paste your key and run validation.
  </Step>

  <Step title="Save configuration">
    Save the key so it can be used by agent tasks.
  </Step>
</Steps>

## Set your first workspace

1. Click `Add Folder` in the sidebar workspace section.
2. Choose the project folder you want Rainy MaTE to use.
3. Confirm that the folder appears as the active workspace.

## Run your first task

1. Open `Agent Chat`.
2. Select a model and agent.
3. Send a prompt such as:

```text theme={null}
Scan this repository and create a short risk-based review plan.
```

4. Approve or reject any Airlock-gated actions.

## Continue

* `/users/first-workflow` for a full first-session checklist.
* `/features/autonomous-workflows` for plan and approval behavior.
* `/users/troubleshooting` if setup or execution fails.