docs(readme): document the wt sync command - #27
Merged
Conversation
epodivilov
marked this pull request as ready for review
July 21, 2026 22:04
epodivilov
force-pushed
the
docs/wt-sync-readme
branch
from
July 21, 2026 22:07
45333d6 to
46d4329
Compare
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
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.
wt syncis registered insrc/index.tsbut had no README section — the only mention was thehooks.post-syncrow in the config options table.Adds a
### wt syncsection under Commands, placed afterwt updateand beforewt doctor, in the same shape as the neighbouring sections: description, flag table, commented examples block, then prose.Documented surface, checked against
src/cli/commands/sync.tsandsrc/application/use-cases/sync-worktrees.ts:branch— syncs all worktrees when omitted, errors when no worktree matches--dry-run— reports the plan, writes nothing, skipspost-synchooks--force— overwrites existing files at copy destinationsThe section also covers when to reach for the command (after editing
copy/symlinksin config, to push those into worktrees that already exist) and links to Options for thepost-synchook. One Features bullet added at the top.Examples were run against the local build (
pnpm dev -- sync --help,--dry-run, positional branch, unknown branch).pnpm lintandpnpm typecheckboth exit 0.Edits are confined to the Features list and the Commands section, staying clear of the hooks/configuration area being changed on
fix/hooks-windows-warning.