# aspire tray command for managing local AppHosts

## Name

`aspire tray` - Manage the desktop tray companion.

## Synopsis

```bash title="Aspire CLI"
aspire tray [command] [options]
```

## Description

The `aspire tray` command manages the Aspire tray companion, a desktop panel icon for managing local AppHosts. The tray is available on Windows, macOS, and glibc Linux (x64 and ARM64). The command is hidden from help on unsupported operating systems and on musl-based Linux.

**Caution:** The tray companion is in preview. It requires a native Aspire CLI
  installation with a bundle that includes the tray companion. Managed
  development builds and using .NET CLI commands aren&#39;t supported.

## Linux requirements

On Linux, the tray uses a **StatusNotifierItem** icon. GNOME renders its D-Bus menu through an **AppIndicator** extension; other desktops display an Aspire-owned panel. Headless sessions and musl-based distributions aren't supported. The following host dependencies, which aren't bundled with the CLI, must also be present:

 - A graphical desktop session
 - GTK 3
 - On GNOME, an **AppIndicator** library, such as Ayatana AppIndicator or a compatible libappindicator, and an enabled AppIndicator extension
 - On non-GNOME Wayland desktops, `libgtk-layer-shell.so.0` and a compositor that supports the layer-shell protocol
 - On non-GNOME X11 desktops, a compositing manager to open the panel
 - A **StatusNotifierItem** tray host, such as Waybar with its tray module enabled

If no tray host is available when you run `aspire tray start`, the CLI reports it. The icon appears as soon as tray support becomes available.

## Options

The following options are available:

- <Include relativePath="reference/cli/includes/option-help.md" />

- <Include relativePath="reference/cli/includes/option-log-level.md" />

- <Include relativePath="reference/cli/includes/option-non-interactive.md" />

- <Include relativePath="reference/cli/includes/option-nologo.md" />

- <Include relativePath="reference/cli/includes/option-banner.md" />

- <Include relativePath="reference/cli/includes/option-wait.md" />

## Commands

The following commands are available:

| Command                                        | Status  | Function                                 |
| ---------------------------------------------- | ------- | ---------------------------------------- |
| [`aspire tray start`](../aspire-tray-start/)   | Preview | Start or restore the tray icon.          |
| [`aspire tray stop`](../aspire-tray-stop/)     | Preview | Stop the tray without stopping AppHosts. |

## See also

- [aspire tray start command](../aspire-tray-start/)
- [aspire tray stop command](../aspire-tray-stop/)
- [aspire ps command](../aspire-ps/)