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

# Terminal UI (TUI)

> View and manage Rootly incidents and alerts from your terminal with the Rootly TUI application, a fast keyboard-driven interface for on-call responders.

<Warning>
  The Rootly TUI is currently in **early preview**. Features may change and some functionality may be limited. Feedback and bug reports are welcome on [GitHub](https://github.com/rootlyhq/rootly-tui/issues).
</Warning>

## Overview

The Rootly TUI is a terminal-based interface for monitoring and triaging incidents and alerts without leaving your command line. Built for engineers who prefer keyboard-driven workflows, it connects directly to the Rootly API using your API key.

<CardGroup cols={2}>
  <Card title="Incidents & Alerts" icon="terminal">
    Browse incidents and alerts with full detail views — severity, status, timeline, roles, labels, and more.
  </Card>

  <Card title="Keyboard-Driven" icon="keyboard">
    Vim-style navigation (`j`/`k`) and intuitive shortcuts for fast, mouse-free operation.
  </Card>

  <Card title="Multi-language" icon="language">
    Available in 12 languages including Spanish, French, Japanese, Arabic, and more.
  </Card>

  <Card title="Open Source" icon="code-branch">
    Fully open source at [rootlyhq/rootly-tui](https://github.com/rootlyhq/rootly-tui). Contributions welcome.
  </Card>
</CardGroup>

## Requirements

* Terminal with 256-color support
* Minimum terminal size: 80×24
* A Rootly API key (generate one from **Settings → API Keys**)

## Installation

<CodeGroup>
  ```bash Homebrew (macOS/Linux) theme={null}
  brew install rootlyhq/tap/rootly-tui
  ```

  ```bash Go theme={null}
  go install github.com/rootlyhq/rootly-tui/cmd/rootly-tui@latest
  ```

  ```bash Build from source theme={null}
  git clone https://github.com/rootlyhq/rootly-tui.git
  cd rootly-tui && make build && ./bin/rootly-tui
  ```
</CodeGroup>

Or download a pre-built binary from [GitHub Releases](https://github.com/rootlyhq/rootly-tui/releases).

## Quick Start

<Steps>
  <Step title="Launch the TUI">
    ```bash theme={null}
    rootly-tui
    ```
  </Step>

  <Step title="Configure your credentials">
    On first launch, you'll be prompted to configure:

    | Setting          | Description                                       | Default          |
    | ---------------- | ------------------------------------------------- | ---------------- |
    | **API Endpoint** | Usually `api.rootly.com`, or your custom endpoint | `api.rootly.com` |
    | **API Key**      | Your Rootly API key                               | —                |
    | **Timezone**     | Timezone for displaying timestamps                | `UTC`            |
    | **Language**     | Display language                                  | `en_US`          |
    | **Layout**       | Panel layout: `horizontal` or `vertical`          | `horizontal`     |

    To update settings later, press `s` in the app.
  </Step>

  <Step title="Navigate incidents and alerts">
    Use `Tab` to switch between the **Incidents** and **Alerts** tabs. Press `Enter` on any item to load its full details.
  </Step>
</Steps>

## Keyboard Shortcuts

### Navigation

| Key       | Action                                   |
| --------- | ---------------------------------------- |
| `j` / `↓` | Move cursor down                         |
| `k` / `↑` | Move cursor up                           |
| `g`       | Go to first item                         |
| `G`       | Go to last item                          |
| `[`       | Previous page                            |
| `]`       | Next page                                |
| `Tab`     | Switch between Incidents and Alerts tabs |

### Actions

| Key     | Action                           |
| ------- | -------------------------------- |
| `Enter` | View details / focus detail pane |
| `o`     | Open in browser                  |
| `c`     | Copy to clipboard                |
| `r`     | Refresh data                     |
| `S`     | Sort menu                        |

### General

| Key                    | Action          |
| ---------------------- | --------------- |
| `l`                    | View debug logs |
| `s`                    | Open settings   |
| `A`                    | About           |
| `?`                    | Show help       |
| `q` / `Esc` / `Ctrl+C` | Quit            |

## Command Line Options

| Flag           | Description                    |
| -------------- | ------------------------------ |
| `--debug`      | Enable debug logging to stderr |
| `--log <file>` | Write debug logs to a file     |
| `--version`    | Show version information       |

### Debug Mode

```bash theme={null}
# Log to stderr
rootly-tui --debug

# Log to file
rootly-tui --log debug.log

# Log to stderr, redirect to file
rootly-tui --debug 2> debug.log
```

Press `l` in the app to open the built-in log viewer.

## Configuration File

Settings are stored at `~/.rootly-tui/config.yaml`:

```yaml theme={null}
api_key: "your-api-key"
endpoint: "api.rootly.com"
timezone: "UTC"
language: "en_US"
layout: "horizontal"
```

## Supported Languages

English (US/GB) · Spanish · French · German · Chinese (Simplified) · Japanese · Russian · Portuguese (Brazilian) · Hindi · Arabic · Bengali

## Feedback & Support

* **Bug reports & feature requests**: [GitHub Issues](https://github.com/rootlyhq/rootly-tui/issues)
* **Source code**: [github.com/rootlyhq/rootly-tui](https://github.com/rootlyhq/rootly-tui)