aboutsummaryrefslogtreecommitdiff
path: root/website/src/content/docs/cli-reference.mdx
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-06-24 16:23:09 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-06-24 16:23:09 +0300
commitbae1f14d3b8989f4ee1eb2053b1146d636c471dd (patch)
tree3ec1cd2909915e8dc969c211a0dac5b7540c5ba1 /website/src/content/docs/cli-reference.mdx
parenta720367889cf8f54108deb1489cbcd06e0d3dfa7 (diff)
docs: finalize release docs
Diffstat (limited to 'website/src/content/docs/cli-reference.mdx')
-rw-r--r--website/src/content/docs/cli-reference.mdx2
1 files changed, 1 insertions, 1 deletions
diff --git a/website/src/content/docs/cli-reference.mdx b/website/src/content/docs/cli-reference.mdx
index f1079995..d841e564 100644
--- a/website/src/content/docs/cli-reference.mdx
+++ b/website/src/content/docs/cli-reference.mdx
@@ -91,7 +91,7 @@ herdr worktree open [--workspace ID | --cwd PATH] (--path PATH | --branch NAME)
herdr worktree remove --workspace ID [--force] [--json]
```
-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. Without `--path`, Herdr creates the checkout under `<worktrees.directory>/<repo>/<branch-slug>`.
+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 `<worktrees.directory>/<repo>/<branch-slug>`.
`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.