From ddffb6e1d79efb517a92034ed18b75c388a36e55 Mon Sep 17 00:00:00 2001 From: Ogulcan Celik Date: Tue, 11 Aug 2026 03:53:55 +0300 Subject: chore: refresh english documentation --- docs/next/README.md | 10 ++-- .../website/src/content/docs/agent-automation.mdx | 4 +- docs/next/website/src/content/docs/agent-skill.mdx | 4 +- docs/next/website/src/content/docs/agents.mdx | 8 ++-- .../website/src/content/docs/cli-reference.mdx | 16 +++---- docs/next/website/src/content/docs/concepts.mdx | 2 +- .../website/src/content/docs/config-reference.mdx | 2 +- .../website/src/content/docs/configuration.mdx | 18 +++---- docs/next/website/src/content/docs/how-to-work.mdx | 4 +- docs/next/website/src/content/docs/index.mdx | 4 +- docs/next/website/src/content/docs/install.mdx | 10 ++-- .../next/website/src/content/docs/integrations.mdx | 14 +++--- docs/next/website/src/content/docs/keyboard.mdx | 6 +-- docs/next/website/src/content/docs/marketplace.mdx | 14 +++--- .../src/content/docs/persistence-remote.mdx | 8 ++-- docs/next/website/src/content/docs/plugins.mdx | 55 +++++++++++----------- docs/next/website/src/content/docs/quick-start.mdx | 10 ++-- .../website/src/content/docs/session-state.mdx | 14 +++--- docs/next/website/src/content/docs/socket-api.mdx | 27 ++++++----- .../website/src/content/docs/troubleshooting.mdx | 6 +-- .../next/website/src/content/docs/windows-beta.mdx | 16 +++---- 21 files changed, 125 insertions(+), 127 deletions(-) (limited to 'docs') diff --git a/docs/next/README.md b/docs/next/README.md index d1fc93a1..31a8a7d2 100644 --- a/docs/next/README.md +++ b/docs/next/README.md @@ -28,10 +28,10 @@ https://github.com/user-attachments/assets/043ec09f-4bdd-41d5-aee0-8fda6b83e267 **the runtime your coding agents live on.** -- **always running** — herdr is a background server; the terminals live inside it. close the lid, drop the network, restart the machine — agents keep working and sessions come back. reattach from any terminal, or over ssh. +- **always running** — herdr is a background server; the terminals live inside it. close the lid, drop the network, or restart the machine; agents keep working and sessions come back. reattach from any terminal, or over ssh. - **never hunt for the stuck one** — every pane is marked working, blocked, or idle. when an agent stops and needs an answer, herdr says so. -- **agent-native** — the cli and socket api are the same surface agents drive: spawn panes, prompt each other, wait until another agent is genuinely blocked. [agent skill →](https://herdr.dev/docs/agent-skill/) -- **runs what you already run** — claude code, codex, cursor, opencode, grok and the rest. herdr doesn't wrap or replace them, it just owns their terminals. +- **agent-native** — agents drive herdr through the cli and socket api: they can spawn panes, prompt each other, and wait until another agent is genuinely blocked. [agent skill →](https://herdr.dev/docs/agent-skill/) +- **runs what you already run** — claude code, codex, cursor, opencode, grok and the rest. herdr doesn't wrap or replace them; it owns their terminals. - **keyboard and mouse, both first-class** — tmux-style prefix keys *and* click, drag, split. pick per moment, not per tool. - **plugins** — extend panes and workflows. [browse the marketplace →](https://herdr.dev/plugins/) - **one rust binary, no electron** — runs in whatever terminal you already use. @@ -60,9 +60,7 @@ everything lives at [herdr.dev/docs](https://herdr.dev/docs/): [quick start](htt ## thanks -Terminal Trove - -[Terminal Trove](https://terminaltrove.com/) and every backer listed in [SPONSORS.md](./SPONSORS.md) — thank you 🐑 +every past sponsor and backer is listed in [SPONSORS.md](./SPONSORS.md) — thank you 🐑 enterprise / partnership: hey@herdr.dev diff --git a/docs/next/website/src/content/docs/agent-automation.mdx b/docs/next/website/src/content/docs/agent-automation.mdx index 807bebd8..33bb14a5 100644 --- a/docs/next/website/src/content/docs/agent-automation.mdx +++ b/docs/next/website/src/content/docs/agent-automation.mdx @@ -3,7 +3,7 @@ title: Agent automation description: Use Herdr's layout, pane, and agent primitives to coordinate coding agents from scripts or other agents. --- -Herdr can act as an automation layer for coding agents. A script can control them, or one agent can create work for other agents, inspect their state, and collect their results. The important part is choosing the primitive that matches the job. +Use Herdr as an automation layer for coding agents. A script can control them, or one agent can create work for other agents, inspect their state, and collect their results. Choose the primitive that matches the job. ## Three primitives @@ -73,7 +73,7 @@ herdr agent rename w1:p2 reviewer Pane input addresses the terminal regardless of its current occupant. Agent input resolves the live agent and rejects the operation if that agent no longer controls the pane. -`agent prompt --wait` submits immediately. When the agent starts from a non-working state, Herdr first requires an observed lifecycle change within five seconds. If the state sequence does not advance, it returns `agent_prompt_stalled` instead of waiting indefinitely; a caller `--timeout` of five seconds or less returns the normal `timeout` error. After activity is observed, it waits for the requested settled status. It does not track individual turns. If the agent is already working, completion of that active turn may satisfy the wait. Standalone `agent wait` observes the current agent and returns immediately if its status already matches. Both commands default to `idle`, `done`, or `blocked`. Repeat `--until` to accept several exact states, for example `--until idle --until done`; use `--until unknown` explicitly when needed. On `agent prompt`, `--until` requires `--wait`. +`agent prompt --wait` submits immediately. If the agent starts from a non-working state, Herdr must observe a lifecycle change within five seconds. Otherwise, it returns `agent_prompt_stalled` instead of waiting indefinitely; a caller `--timeout` of five seconds or less returns the normal `timeout` error. After Herdr observes activity, it waits for the requested settled status. It does not track individual turns. If the agent is already working, completion of that active turn may satisfy the wait. Standalone `agent wait` observes the current agent and returns immediately if its status already matches. Both commands default to `idle`, `done`, or `blocked`. Repeat `--until` to accept several exact states, for example `--until idle --until done`; use `--until unknown` explicitly when needed. On `agent prompt`, `--until` requires `--wait`. `idle` means the agent is ready for input and its tab has been seen in the focused Herdr UI. `done` is the same underlying idle state after background work finishes, until that tab is focused or `pane focus` / `agent focus` targets it. Reading through the CLI does not mark it seen. `blocked` means Herdr recognized an approval or question UI. `unknown` means an agent is present but Herdr cannot classify its lifecycle confidently; it does not prove successful completion. Use exact `--until` states when that distinction matters. diff --git a/docs/next/website/src/content/docs/agent-skill.mdx b/docs/next/website/src/content/docs/agent-skill.mdx index d9c0f162..d73832ac 100644 --- a/docs/next/website/src/content/docs/agent-skill.mdx +++ b/docs/next/website/src/content/docs/agent-skill.mdx @@ -21,7 +21,7 @@ With the skill installed, an agent can: - wait for servers, tests, or another agent to finish - start helper agents in sibling panes -The skill is not a separate app or service. It is a markdown instruction file for agents. If Herdr is already installed, run `herdr --skill` to print the release-matched copy bundled with that binary. +The skill is a Markdown instruction file for agents. If Herdr is already installed, run `herdr --skill` to print the release-matched copy bundled with that binary. ## Install it @@ -50,7 +50,7 @@ herdr claude ``` -Or use any other coding agent in a Herdr pane. The important part is that the agent process runs inside Herdr, so `HERDR_ENV=1` is available. +Or use any other coding agent in a Herdr pane so `HERDR_ENV=1` is available to the agent process. ## Safety rule diff --git a/docs/next/website/src/content/docs/agents.mdx b/docs/next/website/src/content/docs/agents.mdx index 2833f4bb..58939ed4 100644 --- a/docs/next/website/src/content/docs/agents.mdx +++ b/docs/next/website/src/content/docs/agents.mdx @@ -9,7 +9,7 @@ To coordinate agents from scripts or from another agent, see [Agent automation]( ## Supported agents -Automatic detection works out of the box for common coding agents. The important difference is not whether Herdr can see an agent. It is which signal is allowed to author `idle`, `working`, and `blocked`. +Automatic detection works out of the box for common coding agents. The table shows which signal determines `idle`, `working`, and `blocked` for each one. | Agent | State authority | Integration role | | --- | --- | --- | @@ -49,7 +49,7 @@ Integrations marked `session` in the table above are intentionally not lifecycle ## VMs and sandbox wrappers -On Linux and macOS, a host-visible wrapper can hide the real agent process from Herdr. Set `HERDR_AGENT=` on the wrapper command to tell Herdr which existing agent screen manifest to use. For example, run `HERDR_AGENT=claude fence -- claude` on Linux or `HERDR_AGENT=claude nono run --profile claude-code -- claude` on macOS. The hint is scoped to that foreground process; setting it only inside a VM or container is not visible to Herdr, and you should avoid exporting it globally unless every inherited foreground process should be treated as that agent. +On Linux and macOS, a host-visible wrapper can hide the real agent process from Herdr. Set `HERDR_AGENT=` on the wrapper command to tell Herdr which existing agent screen manifest to use. For example, run `HERDR_AGENT=claude fence -- claude` on Linux or `HERDR_AGENT=claude nono run --profile claude-code -- claude` on macOS. The hint applies only to that foreground process. Herdr cannot see it if you set it only inside a VM or container. Avoid exporting it globally unless every inherited foreground process should be treated as that agent. Some restricted Linux runtimes do not expose a terminal foreground process group. Start the Herdr server with `HERDR_PROCESS_DETECTION=child-groups` to opt into direct child-process-group inference when native detection is unavailable. Native detection remains preferred, and the default `native` mode never performs this inference. The opt-in mode is best effort: a newer background job can be mistaken for the foreground job. The variable is read by the server and requires a restart; set it in the remote server environment rather than on an attaching client. @@ -57,7 +57,7 @@ Some restricted Linux runtimes do not expose a terminal foreground process group Blocked detection is deliberately strict for screen-manifest agents. Herdr only marks `blocked` when the live bottom-buffer snapshot matches known visible approval, question, or permission UI. If no manifest rule matches for a known agent, Herdr falls back to `idle` and labels that fallback as `default_known_agent_idle_fallback` in explain output. -This means unusual new agent prompts may initially show as `idle` instead of `blocked` until Herdr learns that screen shape. Those interactions should not make Herdr send input or take destructive action; they only affect the visible status and waits. +This means unusual new agent prompts may initially show as `idle` instead of `blocked` until Herdr learns that screen shape. The misclassification affects only the visible status and waits. It should not make Herdr send input or take destructive action. ## Detection manifests @@ -96,7 +96,7 @@ This is the main Herdr workflow: start several agents, let them work in parallel ## Direct integrations -Install the integration for each agent you use; it gives Herdr hook or plugin reports instead of screen detection alone: +Install the integration for each agent you use to give Herdr hook or plugin reports instead of screen detection alone: ```bash herdr integration install claude diff --git a/docs/next/website/src/content/docs/cli-reference.mdx b/docs/next/website/src/content/docs/cli-reference.mdx index d9317c6e..1a362ca9 100644 --- a/docs/next/website/src/content/docs/cli-reference.mdx +++ b/docs/next/website/src/content/docs/cli-reference.mdx @@ -5,7 +5,7 @@ description: Herdr commands for sessions, workspaces, tabs, panes, notifications Herdr’s CLI talks to the running server over the same local socket API used by integrations and agents. -Most commands print JSON responses. Use them from scripts when you want deterministic automation. +Most commands print JSON responses for deterministic automation in scripts. ## Launch and status @@ -130,7 +130,7 @@ Create a workspace without stealing focus: herdr workspace create --cwd ~/project --label api --no-focus ``` -A workspace is the top-level project or work context. Creating one also creates its first tab and root pane. The JSON response exposes their IDs as `.result.workspace.workspace_id`, `.result.tab.tab_id`, and `.result.root_pane.pane_id`. +A workspace is a top-level project or work context. Creating one also creates its first tab and root pane. The JSON response exposes their IDs as `.result.workspace.workspace_id`, `.result.tab.tab_id`, and `.result.root_pane.pane_id`. ## Worktrees @@ -143,7 +143,7 @@ herdr worktree remove --workspace ID [--force] Worktrees are normal Herdr workspaces with Git checkout provenance. `worktree create` creates a Git worktree checkout, opens it as a workspace, and groups it with the parent repo workspace. If `--branch` names an existing local branch, Herdr checks it out; otherwise it creates the branch from `--base` or `HEAD`. Without `--path`, Herdr creates the checkout under `//`. -`workspace close` closes Herdr state only. `worktree remove` is the explicit checkout deletion path; it runs `git worktree remove`, never deletes the branch, and requires `--force` when Git refuses a dirty checkout. +`workspace close` closes only Herdr state. To delete the checkout, run `worktree remove`. It runs `git worktree remove`, never deletes the branch, and requires `--force` when Git refuses a dirty checkout. ## Tabs @@ -156,7 +156,7 @@ herdr tab rename