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

# Installation

> Install Otter Shell with pikman. Base desktop is `otter-shell`; add `otter-shell-extras` for speech tools and Otter Assistant.

Otter Shell ships as native packages on PikaOS, built and versioned together in [otter-zenith](https://git.pika-os.com/otter-shell/otter-zenith). Install with **pikman**.

## System requirements

* **PikaOS**: Otter Shell packages target PikaOS repositories.
* **Wayland compositor**: Otter Shell is Wayland-only. Pick a compositor that supports the protocols your apps need (for example `zwlr_layer_shell_v1` for the bar, launcher, and most overlays).
* **No Zig runtime needed**: Apps ship as native binaries. Zig is not required.

<Note>
  Otter Shell does **not** install a compositor. You pick and configure your own Wayland session. Hyprland, Sway, and Niri are common on PikaOS. The display manager (`otter-greeter`) uses Hyprland only for the login screen. Your user session compositor is separate.

  Screenshot and color-picker tools (`otter-screenshot`, `otter-pick`, `otter-shot`) need the compositor to expose `ext_image_copy_capture_v1`.
</Note>

## Install with pikman

<Steps>
  <Step title="Update package lists">
    Refresh available packages:

    ```bash theme={null}
    pikman update
    ```
  </Step>

  <Step title="Install Otter Shell">
    Install the desktop metapackage:

    ```bash theme={null}
    pikman install otter-shell
    ```

    Pulls every component at the same version. See the package table below.

    For speech tools and Otter Assistant:

    ```bash theme={null}
    pikman install otter-shell-extras
    ```

    `otter-shell` **recommends** `otter-shell-extras` but does not require it. Transcription, voice synthesis, and Otter Assistant stay out of the base metapackage.
  </Step>

  <Step title="Install individual packages (optional)">
    For specific tools only:

    ```bash theme={null}
    pikman install otter-term otter-bar otter-launcher
    ```
  </Step>
</Steps>

## Metapackages

| Metapackage          | Contents                                                                                                                                                                                                                                                                        |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `otter-shell`        | Full desktop shell: bar, launcher, notifications, wallpaper, theme generator, OSD, logout, settings, polkit, lock, idle, greeter, terminal, system monitor, Jade pet, screenshot tools, clipboard, notes, timer, weather, and other core helpers. Includes `otter-shell-fonts`. |
| `otter-shell-extras` | Speech tools (`otter-transcribe`, `otter-vox`) and Otter Assistant (`otter-assist`, `otter-assistant`, `otter-assist-data`).                                                                                                                                                    |

## Packages in `otter-shell`

Installed by `pikman install otter-shell`:

| Package               | Description                                             |
| --------------------- | ------------------------------------------------------- |
| `otter-bar`           | Status bar with widgets, system tray, and MPRIS         |
| `otter-launcher`      | Application launcher overlay                            |
| `otter-search`        | Desktop search daemon (launcher `file` / `grep` modes)  |
| `otter-notifications` | Notification daemon (freedesktop.org spec)              |
| `otter-wallpaper`     | Wallpaper daemon                                        |
| `otter-theme-gen`     | Wallpaper-reactive theme generator                      |
| `otter-osd`           | On-screen display for volume, brightness, and lock keys |
| `otter-logout`        | Power menu overlay                                      |
| `otter-settings`      | Graphical settings editor                               |
| `otter-polkit`        | Polkit authentication agent                             |
| `otter-lock`          | Session lockscreen                                      |
| `otter-idle`          | Idle management daemon                                  |
| `otter-greeter`       | Display manager (login screen)                          |
| `otter-term`          | Terminal emulator                                       |
| `otter-monitor`       | System monitor with process tables and resource graphs  |
| `otter-jade`          | Desktop pet                                             |
| `otter-screenshot`    | Region and fullscreen screenshots                       |
| `otter-shot`          | Product-shot composer                                   |
| `otter-rec`           | Screen recorder                                         |
| `otter-clip`          | Clipboard manager                                       |
| `otter-note`          | Sticky notes                                            |
| `otter-cal`           | Calendar helper for the bar                             |
| `otter-calc`          | Calculator helper                                       |
| `otter-emoji`         | Emoji picker helper                                     |
| `otter-timer`         | Countdown timer                                         |
| `otter-pick`          | Color picker                                            |
| `otter-clicker`       | Auto-clicker with point selection                       |
| `otter-weather`       | Weather fetcher and bar widget                          |
| `otter-shell-fonts`   | Bundled fallback fonts                                  |

**Not in the base metapackage** (install via `otter-shell-extras`): `otter-transcribe`, `otter-vox`, `otter-assist`, `otter-assistant`, and `otter-assist-data`.

## Verify the installation

```bash theme={null}
otter-term
```

A terminal window should open on your Wayland session. Then follow [Quick Start](/quickstart) and [Session setup](/desktop/session-setup) to autostart shell daemons.