Skip to content

docs(readme): document the wt sync command - #27

Merged
epodivilov merged 1 commit into
mainfrom
docs/wt-sync-readme
Jul 22, 2026
Merged

docs(readme): document the wt sync command#27
epodivilov merged 1 commit into
mainfrom
docs/wt-sync-readme

Conversation

@epodivilov

Copy link
Copy Markdown
Owner

wt sync is registered in src/index.ts but had no README section — the only mention was the hooks.post-sync row in the config options table.

Adds a ### wt sync section under Commands, placed after wt update and before wt 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.ts and src/application/use-cases/sync-worktrees.ts:

  • positional branch — syncs all worktrees when omitted, errors when no worktree matches
  • --dry-run — reports the plan, writes nothing, skips post-sync hooks
  • --force — overwrites existing files at copy destinations

The section also covers when to reach for the command (after editing copy/symlinks in config, to push those into worktrees that already exist) and links to Options for the post-sync hook. 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 lint and pnpm typecheck both 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.

@epodivilov
epodivilov marked this pull request as ready for review July 21, 2026 22:04
@epodivilov
epodivilov force-pushed the docs/wt-sync-readme branch from 45333d6 to 46d4329 Compare July 21, 2026 22:07
@epodivilov
epodivilov merged commit 74f92b6 into main Jul 22, 2026
1 check passed
@epodivilov
epodivilov deleted the docs/wt-sync-readme branch July 22, 2026 07:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant