Skip to content

Commit 5f8cea5

Browse files
committed
docs: update README for v0.3.0
1 parent 8d5907e commit 5f8cea5

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,16 @@ workz start feature/login
2525

2626
## Features
2727

28-
- **Auto-symlink heavy directories**`node_modules`, `target`, `.venv`, `vendor`, and 18+ more are symlinked, not duplicated
28+
- **Auto-symlink heavy directories**`node_modules`, `target`, `.venv`, `vendor`, and 22+ more are symlinked, not duplicated
2929
- **Auto-copy env files**`.env`, `.env.local`, `.envrc`, `.npmrc`, secrets, and more carried over automatically
30+
- **IDE config sync**`.vscode`, `.idea`, `.cursor`, `.claude`, `.zed` symlinked automatically
3031
- **Smart project detection** — auto-detects Node/Rust/Python/Go/Java projects and only syncs relevant dirs
3132
- **Auto-install dependencies** — detects your package manager from lockfiles and installs if deps are missing
3233
- **Fuzzy TUI switching** — skim-powered fzf-style fuzzy finder to jump between worktrees
34+
- **Rich status dashboard**`workz status` shows branch, dirty state, disk size, last commit age
3335
- **Docker support**`--docker` flag to auto-start containers, auto-stop on `done`
34-
- **AI-agent ready** — launch Claude Code, Cursor, or VS Code in a worktree with `--ai`
36+
- **AI-agent ready** — launch Claude, Cursor, VS Code, Aider, Codex, Gemini, or Windsurf with `--ai`
37+
- **Sync existing worktrees**`workz sync` applies full setup to worktrees not created by workz
3538
- **Shell integration**`cd` into worktrees automatically, just like zoxide
3639
- **Global + project config**`~/.config/workz/config.toml` for defaults, `.workz.toml` per project
3740
- **Zero config** — works out of the box for Node, Rust, Python, Go, and Java projects
@@ -126,10 +129,24 @@ cd ../my-existing-worktree
126129
workz sync # applies symlinks, copies .env files, installs deps
127130
```
128131

132+
### Rich status dashboard
133+
134+
```bash
135+
workz status
136+
```
137+
138+
```
139+
main /home/you/myrepo [modified] 342K 2 hours ago
140+
feature-login /home/you/myrepo--feature-login 1.2M 5 minutes ago [docker]
141+
bugfix-crash /home/you/myrepo--bugfix-crash 890K 3 days ago
142+
```
143+
129144
### Clean up stale entries
130145

131146
```bash
132-
workz clean
147+
workz clean # prune stale worktree refs
148+
workz clean --merged # also remove worktrees with merged branches
149+
workz clean --merged --base main # specify base branch explicitly
133150
```
134151

135152
## Configuration
@@ -164,13 +181,14 @@ Without a config file, workz uses sensible defaults that work for most projects.
164181

165182
### Default sync rules
166183

167-
**Symlinked directories** (22 dirs, project-type aware):
184+
**Symlinked directories** (27 dirs, project-type aware):
168185
- **Node**: `node_modules`, `.next`, `.nuxt`, `.svelte-kit`, `.turbo`, `.parcel-cache`, `.angular`
169186
- **Rust**: `target`
170187
- **Python**: `.venv`, `venv`, `__pycache__`, `.mypy_cache`, `.pytest_cache`, `.ruff_cache`
171188
- **Go**: `vendor`
172189
- **Java/Kotlin**: `.gradle`, `build`
173190
- **General**: `.direnv`, `.cache`
191+
- **IDE configs**: `.vscode`, `.idea`, `.cursor`, `.claude`, `.zed`
174192

175193
**Copied files** (17 patterns):
176194
- `.env`, `.env.*`, `.envrc`, `.tool-versions`, `.node-version`, `.python-version`, `.ruby-version`, `.nvmrc`, `.npmrc`, `.yarnrc.yml`, `docker-compose.override.yml`, `.secrets`, `.secrets.*`
@@ -206,9 +224,12 @@ Supports both `docker compose` and `podman-compose` (prefers podman if available
206224
Running multiple AI agents in parallel? Each one needs its own worktree:
207225

208226
```bash
209-
workz start feature/auth --ai # launches Claude Code
210-
workz start feature/ui --ai --ai-tool cursor # launches Cursor
211-
workz start bugfix/perf --ai --ai-tool code # launches VS Code
227+
workz start feature/auth --ai # launches Claude Code (default)
228+
workz start feature/ui --ai --ai-tool cursor # launches Cursor
229+
workz start feature/api --ai --ai-tool aider # launches Aider
230+
workz start feature/test --ai --ai-tool codex # launches OpenAI Codex CLI
231+
workz start feature/x --ai --ai-tool gemini # launches Gemini CLI
232+
workz start feature/y --ai --ai-tool windsurf # launches Windsurf
212233
```
213234

214235
## How It Compares

0 commit comments

Comments
 (0)