You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: clarify arb create options and move Tips section (#10)
Refines descriptions of `--branch`, `--base`, and `--all-repos` options in `arb create` examples. Moves the Tips section to avoid interrupting the flow.
This creates a `fix-login` workspace, checks out a `fix-login` branch in `frontend` and `backend`, and creates separate working directories for each under `fix-login/`. The branches are created if they do not exist.
125
125
126
-
Use `--branch` (`-b`) when the branch name differs from the workspace name, and `--all-repos` (`-a`) to include every cloned repo:
126
+
Use `--branch` (`-b`) when the branch name differs from the workspace name, `--base` when you want to target a specific base branch (instead of each repo's default), and `--all-repos` (`-a`) to include every cloned repo:
Running `arb create` without arguments walks you through it interactively. See `arb create --help` for all options.
@@ -164,7 +164,7 @@ This shows the state of each worktree in a compact table with labeled columns:
164
164
local-lib my-feature main aligned local clean
165
165
```
166
166
167
-
This view is designed to give you the full picture in one glance — repo name, current branch, how far you've drifted from the base branch, whether the remote is ahead or behind, and what's uncommitted locally. Yellow highlights things that need attention: unpushed commits, local changes, unexpected branches.
167
+
This view is designed to give you the full picture in one glance — repo name, current branch, how far you've drifted from the base branch, whether the remote is ahead or behind, and what's uncommitted locally. Yellow highlights things that need attention: unpushed commits, local changes, repos on an unexpected branch (like `repo-c` above).
168
168
169
169
See `arb status --help` for all options.
170
170
@@ -287,31 +287,6 @@ arb remove fix-login
287
287
288
288
This shows the status of each worktree and walks you through removal. If there are uncommitted changes or unpushed commits, arb refuses to proceed unless you pass `--force`. When workspace templates are in use, arb also lists any template-sourced files that were modified — giving you a chance to update the templates before removing the workspace. Use `--delete-remote` to also clean up the remote branches, and `--all-ok` to batch-remove every workspace with ok status. See `arb remove --help` for all options.
289
289
290
-
## Tips
291
-
292
-
### Browsing the default branch
293
-
294
-
To view the latest default-branch code across all repos:
295
-
296
-
```bash
297
-
arb create main --all-repos # assuming main is the default branch
298
-
```
299
-
300
-
_Note_: Creating a workspace for the default branch works because Arborist keeps the canonical clones in detached HEAD state.
301
-
302
-
### Working with AI agents
303
-
304
-
When using Claude Code or other AI coding agents, start them from the workspace directory rather than an individual worktree. This gives the agent visibility across all repos in the workspace.
305
-
306
-
### Multiple arb roots
307
-
308
-
Each arb root is independent. Commands find the right one by walking up from the current directory looking for the `.arb/` marker. Feel free to create multiple roots for different projects:
309
-
310
-
```bash
311
-
cd~/project-a && arb init
312
-
cd~/project-b && arb init
313
-
```
314
-
315
290
## Workspace templates
316
291
317
292
Arborist can automatically seed files into new workspaces — `.env` files, Claude Code settings, IDE config, anything you want pre-provisioned. Put your templates in `.arb/templates/` and they are copied into every new workspace.
@@ -444,6 +419,31 @@ fi
444
419
445
420
Human-facing output (progress, prompts, summaries) goes to stderr. Machine-parseable data (`--json`, `arb path`) goes to stdout. Colors are stripped automatically in non-TTY environments.
446
421
422
+
## Tips
423
+
424
+
### Browsing the default branch
425
+
426
+
To view the latest default-branch code across all repos:
427
+
428
+
```bash
429
+
arb create main --all-repos # assuming main is the default branch
430
+
```
431
+
432
+
_Note_: Creating a workspace for the default branch works because Arborist keeps the canonical clones in detached HEAD state.
433
+
434
+
### Working with AI agents
435
+
436
+
When using Claude Code or other AI coding agents, start them from the workspace directory rather than an individual worktree. This gives the agent visibility across all repos in the workspace.
437
+
438
+
### Multiple arb roots
439
+
440
+
Each arb root is independent. Commands find the right one by walking up from the current directory looking for the `.arb/` marker. Feel free to create multiple roots for different projects:
441
+
442
+
```bash
443
+
cd~/project-a && arb init
444
+
cd~/project-b && arb init
445
+
```
446
+
447
447
## How it works
448
448
449
449
Arb uses marker directories and Git worktrees — no database, no daemon, no config outside the arb root.
0 commit comments