diff options
| author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2026-08-03 19:00:20 +0000 |
|---|---|---|
| committer | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2026-08-03 19:00:20 +0000 |
| commit | 3642e67c7b9c1d8608d72f288e80b410c602e55c (patch) | |
| tree | 31e956f8d0ce3ffa7ad06495c6523cc3c7b3a3a5 /website/src/content/docs/how-to-work.mdx | |
| parent | 346411fa21afd297f5ed3b3fa56f9e3fbf7654b7 (diff) | |
docs: update website manifest for v0.8.0
Diffstat (limited to 'website/src/content/docs/how-to-work.mdx')
| -rw-r--r-- | website/src/content/docs/how-to-work.mdx | 103 |
1 files changed, 0 insertions, 103 deletions
diff --git a/website/src/content/docs/how-to-work.mdx b/website/src/content/docs/how-to-work.mdx deleted file mode 100644 index 812aae9f..00000000 --- a/website/src/content/docs/how-to-work.mdx +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: How to work with Herdr -description: Run Herdr locally, inside SSH, or through remote attach. ---- - -Run Herdr where the work lives. Attach from wherever you are. - -Herdr is a background session server plus one or more terminal clients. Panes keep running in the server. Clients attach, detach, and render the session. - -## Local work - -Start Herdr from the project directory: - -```bash -herdr -``` - -Herdr starts or attaches to your local background session automatically. You do not manage sockets. Run shells, servers, tests, and agents normally inside panes. - -Detach the client with `ctrl+b q`. Your panes keep running. - -Reattach later: - -```bash -herdr -``` - -If you want to end the session and stop its panes, stop the server: - -```bash -herdr server stop -``` - -## Remote work through normal SSH - -SSH to the machine that has the code and credentials, then run Herdr there: - -```bash -ssh you@server -herdr -``` - -This works like a terminal multiplexer. Your shell is remote. The Herdr server is remote. The agents and panes run on the remote machine. Detach with `ctrl+b q`, disconnect, then SSH back and run `herdr` again. - -Use this path when you already live inside an SSH shell, when you are on a phone or tablet SSH client, or when you want the simplest possible setup. - -## Work from your phone - -You do not need a Herdr mobile app or a web dashboard. Install any SSH client on your phone, connect to the machine where your agents run, and start Herdr there: - -```bash -ssh you@server -herdr -``` - -The same persistent Herdr session opens in your phone terminal. The TUI adapts to narrow screens, so you can inspect agents, switch workspaces, and check panes without leaving SSH. - -On iPhone, apps like [moshi](https://getmoshi.app/) work well. - -<div class="mobile-doc-shots"> - <figure> - <img src="/assets/mobile-agent-session-v2.jpeg" alt="Herdr agent session over SSH on a phone" loading="lazy" /> - <figcaption>agent session over SSH</figcaption> - </figure> - <figure> - <img src="/assets/mobile-switch-menu-v2.jpeg" alt="Herdr responsive switch menu on a phone" loading="lazy" /> - <figcaption>responsive switch menu</figcaption> - </figure> -</div> - -## Remote work from your local terminal - -Attach through SSH without opening a shell first: - -```bash -herdr --remote workbox -herdr --remote ssh://you@server:2222 -``` - -Your local Herdr acts as a thin client. It connects over SSH, starts or attaches to the remote Herdr server, and streams the UI back to your local terminal. - -Use this path when you want the remote session to feel local. The client runs on your machine, so local desktop features such as image clipboard paste can be bridged to the remote server. If you SSH first and run `herdr` on the server, Herdr runs entirely on that server and cannot read your local desktop clipboard. - -For repeat targets, put the host in your SSH config: - -```text -Host workbox - HostName server.example.com - User you - Port 2222 -``` - -Then attach with: - -```bash -herdr --remote workbox -``` - -## Which path to use - -Use `herdr` for local work. Use `ssh you@server` then `herdr` when you want Herdr to behave like tmux on that remote shell or when you are using a phone SSH client. Use `herdr --remote <host>` when you want a local thin client for a remote session, including local clipboard image paste bridging. - -For remote bootstrap details, named remote sessions, custom binaries, direct terminal attach, and `--no-session`, see [Persistence and remote access](/docs/persistence-remote/). |
