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

# Desktop App

> Accessing Onyx via the desktop application

Features include:

* A global shortcut that opens Onyx from any app
* Quick launch from the menu bar or system tray
* Multiple windows, with window size and position remembered between sessions

![Onyx Desktop App](https://mintcdn.com/danswer/ZNIqfhgbS6UAO4T2/assets/overview/onyx_anywhere/desktop_app.webp?fit=max\&auto=format\&n=ZNIqfhgbS6UAO4T2\&q=85\&s=e24cdd3cadd303522a94c6c09fdcb687)

> [!NOTE]
>
> The desktop app shows the same Onyx web app in a native window. It is available on all editions.

## Download

> [card] [Windows](https://github.com/onyx-dot-app/onyx/releases/latest/download/Onyx_x64.exe)
>
> Download .exe

> [card] [macOS](https://github.com/onyx-dot-app/onyx/releases/latest/download/Onyx_universal.dmg)
>
> Download .dmg

> [card] [Linux](https://github.com/onyx-dot-app/onyx/releases/latest/download/Onyx_amd64.deb)
>
> Download .deb

> [!TIP]
>
> Other formats and architectures are on the [GitHub Releases
> page](https://github.com/onyx-dot-app/onyx/releases/latest): `.msi` and ARM64 `.exe` for Windows,
> `.rpm` and ARM64 `.deb` for Linux, and `.app.tar.gz` for macOS.

## Getting Started

**For Onyx Cloud users**: Download the app from the links above. It connects to `https://cloud.onyx.app` by default.

**For self-hosted users**: Point the app at your Onyx server. If the app cannot reach a server,
it shows a **Settings** page. Enter your server URL and select **Save & Connect**.

You can also edit the config file. Select **Open Config File** from the app menu (`Cmd+,` on macOS,
`Ctrl+,` on Windows and Linux), change `server_url`, and restart the app:

```json theme={null}
{
  "server_url": "https://onyx.example.com",
  "window_title": "Onyx"
}
```

The config file is at:

* **macOS**: `~/Library/Application Support/app.onyx.onyx-desktop/config.json`
* **Linux**: `~/.config/onyx-desktop/config.json`
* **Windows**: `%APPDATA%\onyx\onyx-desktop\config\config.json`

## Summon Onyx from anywhere

Press the summon shortcut to bring Onyx to the front from any app:

* **macOS**: `Cmd+Shift+Space`
* **Windows and Linux**: `Ctrl+Alt+Space`

By default, the summon shortcut starts a new chat. Use the menu bar or tray icon to turn **New Chat on Summon** off,
or to hide the icon with **Show in Menu Bar**. To change the shortcut, set `summon_shortcut` in the config file.
Set it to `null` to turn the shortcut off.

## Keyboard Shortcuts

| Shortcut (macOS / Windows and Linux) | Action |
| - | - |
| `Cmd+N` / `Ctrl+N` | New Chat |
| `Cmd+Shift+N` / `Ctrl+Shift+N` | New Window |
| `Cmd+R` / `Ctrl+R` | Reload |
| `Cmd+[` / `Ctrl+[` | Back |
| `Cmd+]` / `Ctrl+]` | Forward |
| `Cmd+,` / `Ctrl+,` | Open Config File |


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