From f74602b8813c4937dad505c60ca2f44b3e9b21a1 Mon Sep 17 00:00:00 2001 From: Ogulcan Celik Date: Mon, 18 May 2026 01:39:39 +0300 Subject: docs: redesign website and add starlight docs --- website/src/content/docs/index.mdx | 104 +++++++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 website/src/content/docs/index.mdx (limited to 'website/src/content/docs/index.mdx') 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 + + + + Herdr runs panes in a background session server, so agents keep running after the UI client detaches. + + [Use persistence →](/docs/persistence-remote/) + + + 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) + + + Every pane is a real terminal. Split layouts, click panes, drag borders, select text, and use right-click menus. + + [Learn concepts →](/docs/concepts/) + + + 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/) + + + +## Start here + + + + Install Herdr on Linux or macOS, update it later, and verify the binary. + + [Install Herdr →](/docs/install/) + + + Create your first workspace, run agents in panes, split the layout, and detach safely. + + [Start using Herdr →](/docs/quick-start/) + + + Understand workspaces, tabs, panes, agents, sessions, modes, and state rollups. + + [Learn the model →](/docs/concepts/) + + + +## Guides and reference + + + + See supported agents, detection behavior, integrations, custom labels, and direct attach. + + [Understand agents →](/docs/agents/) + + + Configure keybindings, themes, sidebar behavior, notifications, scrollback, and advanced options. + + [Configure Herdr →](/docs/configuration/) + + + Install agent integrations for Pi, Claude Code, Codex, and OpenCode. + + [Set up integrations →](/docs/integrations/) + + + Use every Herdr command for sessions, workspaces, tabs, panes, agents, waits, and integrations. + + [Browse commands →](/docs/cli-reference/) + + + Control Herdr from scripts, tools, and agents through the local socket API. + + [Read the API guide →](/docs/socket-api/) + + + Teach an agent running inside Herdr how to create panes, read output, and wait for neighboring agents. + + [Use the skill →](/docs/agent-skill/) + + -- cgit v1.2.3