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

# Installation

> Install Nagare on Linux, macOS, and Windows using the official installation script.

## Requirements

* Operating system: Linux, macOS, or Windows.
* CPU architecture: `amd64` or `arm64`.
* An API key from an OpenAI-compatible or Google model provider.
* The operating system's keyring must be functional (Nagare stores the RSA key there).

## Install via Script

> [tab] Linux / macOS
>
> ```bash theme={null}
> curl -fsSL https://raw.githubusercontent.com/smtdfc/nagare/main/installers/linux/install.sh | sudo bash
> ```

> [tab] Windows (PowerShell)
>
> ```powershell theme={null}
> irm https://raw.githubusercontent.com/smtdfc/nagare/main/installers/window/install.ps1 | iex
> ```

The installation script will:

1. Download the latest release `nagare-<OS>-<ARCH>.tar.gz` from [GitHub Releases](https://github.com/smtdfc/nagare/releases). If the current directory contains `./dist/nagare`, the script installs directly from the `dist` directory instead of downloading.
2. Install three executables into `$HOME/.local/bin`:
   * `nagare`: CLI.
   * `nagare-gateway`: gateway process.
   * `nagare-desktop`: desktop application.
3. Copy assets to `~/.nagare/assets/` (built-in plugins, core plugins, and web interface).
4. Install the `nagare_vector` module into `~/.nagare/modules`.

## Add to PATH

If the `nagare` command is not found, add `$HOME/.local/bin` to your `PATH`:

```bash theme={null}
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
```

Replace `~/.bashrc` with `~/.zshrc` if you use zsh.

## Verify Installation

```bash theme={null}
nagare --version
nagare doctor
```

`nagare doctor` will report a gateway error when the gateway is not running. This is normal before you run `nagare gateway start`.

## Desktop App

`nagare-desktop` opens the "Nagare Desktop" window using the same interface as the web version. The application reads two environment variables to log in automatically:

| Variable | Meaning |
| - | - |
| `NAGARE_GATEWAY_URL` | Gateway address, for example `http://localhost:9832`. |
| `NAGARE_AUTH_TOKEN` | Token created with `nagare auth token`. |

```bash theme={null}
nagare auth token
# Your token is: <TOKEN>

NAGARE_GATEWAY_URL=http://localhost:9832 \
NAGARE_AUTH_TOKEN="<TOKEN>" \
nagare-desktop
```

If you do not set these variables, you can paste the token directly on the login screen.

## Data Directory

All data is located in `~/.nagare`. See [Configuration](https://docs.nagare.smtdfc.net/en/reference/configuration.md#data-directory) for details. To completely uninstall, stop the gateway, delete the executables in `$HOME/.local/bin`, and delete the `~/.nagare` directory.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.