---
title: Herdr documentation
description: Terminal-native agent runtime and multiplexer.
template: splash
hero:
  tagline: "One terminal for the whole herd: real panes, persistent sessions, SSH attach, state awareness, and CLI/socket orchestration."
  image:
    file: ../../../public/assets/logo.svg
  actions:
    - text: Install Herdr
      link: /docs/install/
    - text: Quick start
      link: /docs/quick-start/
      variant: secondary
---

import { Card, CardGrid } from '@astrojs/starlight/components';

Herdr is a terminal-native agent runtime and multiplexer. It gives the whole herd persistent terminal workspaces with panes, tabs, mouse control, state awareness, and an API that agents can use themselves.

```bash
curl -fsSL https://herdr.dev/install.sh | sh
herdr
```

## Core runtime

<CardGrid>
  <Card title="Detach and reattach">
    Herdr runs panes in a background session server, so agents keep running after the UI client detaches.

    [Use persistence →](/docs/persistence-remote/)
  </Card>
  <Card title="Attach over SSH">
    Run Herdr where the code and credentials live. Attach from any SSH client or use `herdr --remote` from your local terminal.

    [Use remote access →](/docs/persistence-remote/#remote-attach-over-ssh)
  </Card>
  <Card title="Real terminal panes">
    Every pane is a real terminal. Split layouts, click panes, drag borders, select text, and use right-click menus.

    [Learn concepts →](/docs/concepts/)
  </Card>
  <Card title="Runtime API">
    See agent status in the sidebar and drive workspaces, tabs, panes, waits, and output reads through the CLI or socket API.

    [Read the API guide →](/docs/socket-api/)
  </Card>
</CardGrid>

## Start here

<CardGrid>
  <Card title="Install">
    Install Herdr on Linux or macOS, update it later, and verify the binary.

    [Install Herdr →](/docs/install/)
  </Card>
  <Card title="Quick start">
    Create your first workspace, run agents in panes, split the layout, and detach safely.

    [Start using Herdr →](/docs/quick-start/)
  </Card>
  <Card title="Concepts">
    Understand workspaces, tabs, panes, agents, sessions, modes, and state rollups.

    [Learn the model →](/docs/concepts/)
  </Card>
</CardGrid>

## Guides and reference

<CardGrid>
  <Card title="Agents">
    See supported agents, detection behavior, integrations, custom labels, and direct attach.

    [Understand agents →](/docs/agents/)
  </Card>
  <Card title="Configuration">
    Configure keybindings, themes, sidebar behavior, notifications, scrollback, and advanced options.

    [Configure Herdr →](/docs/configuration/)
  </Card>
  <Card title="Integrations">
    Install agent integrations for Pi, Claude Code, Codex, and OpenCode.

    [Set up integrations →](/docs/integrations/)
  </Card>
  <Card title="CLI reference">
    Use every Herdr command for sessions, workspaces, tabs, panes, agents, waits, and integrations.

    [Browse commands →](/docs/cli-reference/)
  </Card>
  <Card title="Socket API">
    Control Herdr from scripts, tools, and agents through the local socket API.

    [Read the API guide →](/docs/socket-api/)
  </Card>
  <Card title="Agent skill">
    Teach an agent running inside Herdr how to create panes, read output, and wait for neighboring agents.

    [Use the skill →](/docs/agent-skill/)
  </Card>
</CardGrid>
