docs(readme): document missing commands and features#22
Merged
Conversation
Add documentation for several existing but undocumented surfaces: - wt self-update: in-place binary update with supported platforms - wt list --json: JSON output shape for scripting and AI agents - wt list drift badge: explain "dir≠branch" indicator - wt update --cleanup: combined fetch + rebase + drop gone branches - post-sync hook: ran after wt sync applies config changes Closes Vikunja #41 (id 213)
- Drift badge: drop the inaccurate "lives under rootDir" clause — isDrifted() fires for any worktree whose path != <rootDir>/<branch>, including worktrees placed outside rootDir. - wt update --cleanup example: clarify that only merged stale branches are dropped — unmerged ones are kept and require `wt cleanup --force`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents several existing but undocumented surfaces in the README:
wt self-update— new section covering in-place binary replacement, supported platforms (Linux/macOS x64/arm64), and Windows fallback to the PowerShell installer.wt list --json— JSON output shape (branch,path,isMain,isCurrent,drifted) with an example.wt listdrift badge — explains whendir≠branchappears (worktree directory name doesn't match its branch, e.g. after a rename).wt update --cleanup— added to the flags table and documented as a one-shot fetch + rebase + drop-gone-branches command; also clarifies behavior under--non-interactive.post-synchook — added to the configuration Options table; existing Hook Environment Variables section already covers the variables it receives (all hooks getWORKTREE_PATH/WORKTREE_BRANCH/REPO_ROOT;post-syncdoes not getBASE_BRANCH, which matchesrun-hooks.ts).Why
These features ship today but were invisible in the README, making them hard to discover. No code changes.
Closes Vikunja #41 (id 213)
Test plan
pnpm lintpassespnpm formatpasses (no changes)