aboutsummaryrefslogtreecommitdiff
path: root/SOCKET_API.md
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-04-09 04:40:50 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-04-09 04:42:35 +0300
commitbb2c579df206e51d43833544d114f321423c997c (patch)
treea26c6702e048f31429ebaa260ee40c3c2b111d3e /SOCKET_API.md
parent5460a9601ea8dd3d05e64e97040c71c6be29172b (diff)
feat(cli): support labels when creating tabs and workspaces
Diffstat (limited to 'SOCKET_API.md')
-rw-r--r--SOCKET_API.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/SOCKET_API.md b/SOCKET_API.md
index c73e0a7d..2739b96d 100644
--- a/SOCKET_API.md
+++ b/SOCKET_API.md
@@ -801,7 +801,7 @@ workspace commands:
```text
herdr workspace list
-herdr workspace create [--cwd PATH] [--no-focus]
+herdr workspace create [--cwd PATH] [--label TEXT] [--no-focus]
herdr workspace get <workspace_id>
herdr workspace focus <workspace_id>
herdr workspace rename <workspace_id> <label>
@@ -812,7 +812,7 @@ tab commands:
```text
herdr tab list [--workspace <workspace_id>]
-herdr tab create [--workspace <workspace_id>] [--cwd PATH] [--no-focus]
+herdr tab create [--workspace <workspace_id>] [--cwd PATH] [--label TEXT] [--no-focus]
herdr tab get <tab_id>
herdr tab focus <tab_id>
herdr tab rename <tab_id> <label>
@@ -842,7 +842,11 @@ herdr wait agent-status <pane_id> --status <idle|working|blocked|done|unknown> [
### cli behavior notes
- `workspace create` focuses by default; pass `--no-focus` to keep focus where it is
+- `workspace create` without `--label` keeps the default cwd-based workspace naming
+- `workspace create --label` applies the custom workspace name immediately
- `tab create` focuses by default; pass `--no-focus` to keep focus where it is
+- `tab create` without `--label` keeps the default numbered tab naming
+- `tab create --label` applies the custom tab name immediately
- `pane split` focuses the new pane by default; pass `--no-focus` to keep focus on the original pane
- `pane read` prints **text**, not json
- `pane read --source recent-unwrapped` returns recent terminal text with soft wraps joined back together
@@ -859,7 +863,7 @@ herdr wait agent-status <pane_id> --status <idle|working|blocked|done|unknown> [
create a workspace, split a pane, run a server, and wait for readiness:
```bash
-herdr workspace create --cwd /path/to/project
+herdr workspace create --cwd /path/to/project --label "api server"
herdr pane split 1-1 --direction right --no-focus
herdr pane run 1-2 "npm run dev"
herdr wait output 1-2 --match "ready" --timeout 30000