diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-18 01:39:39 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-18 05:06:41 +0300 |
| commit | f74602b8813c4937dad505c60ca2f44b3e9b21a1 (patch) | |
| tree | 84d8e27a91a6c4198c59405e6a24848e21ed227b /website/src/content/docs/index.mdx | |
| parent | a3d465687b4f5cd16ce5ecc554c163dd45f15a94 (diff) | |
docs: redesign website and add starlight docs
Diffstat (limited to 'website/src/content/docs/index.mdx')
| -rw-r--r-- | website/src/content/docs/index.mdx | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/website/src/content/docs/index.mdx b/website/src/content/docs/index.mdx new file mode 100644 index 00000000..2e7ecd5e --- /dev/null +++ b/website/src/content/docs/index.mdx @@ -0,0 +1,104 @@ +--- +title: Herdr documentation +description: Terminal multiplexer for AI coding agents. +template: splash +hero: + tagline: Run agents in real terminal panes, keep sessions alive, attach over SSH, and orchestrate everything from the CLI or socket API. + image: + file: ../../../public/assets/logo.png + 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 multiplexer. It gives AI coding agents 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 model + +<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="State and orchestration"> + 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> |
