README
¶
git-wt
Git Extension For Worktree Management
Caveat Emptor
This is very new code. It has not had extensive testing. Use in full knowledge there may be bugs.
Purpose
This helper is intended to assist in managing git worktrees in a workflow based on a project folder with worktrees beneath it.
It features a much shorter syntax, and a streamlined feature set. More advanced
worktree usage should use git worktree directly.
Syntax
It is intended to run as a git helper, with git-wt in your path, using git wt
to invoke it. You can run git-wt directly if you wish.
Syntax is: git wt <command>
Commands are:
cl- Prepare a project directory by cloning the default branch and writing a
git-wtconfiguration file in that project directory.
- Prepare a project directory by cloning the default branch and writing a
ls- List the worktrees in the project.
mk- Add a worktree to the project.
mv- Move a worktree within the project.
rm- Remove a worktree from the project.
xx- Reset the project.
Project Layout
graph TD
root[Project Folder]
cfg[.git-wt
Config File]
def[default_branch_name
Folder]
wt[worktree_name...
Worktree Folders]
root---cfg
root---def
root---wt
Git Worktree Coverage
The goal is to cover the git worktree commands essential to a worktree-based
workflow. Not every command is likely to be implemented, or implemented with all
possible flags.
| Git Worktree Command | git-wt Command | Notes |
|---|---|---|
| list | ls | No arguments supported. |
| add | mk | Does not implement locks or guess-remote. |
| remove | rm | Full implementation. |
| move | mv | Full implementation. |
| prune | tbd | Under review. |
| lock | n/a | No intent to implement. |
| unlock | n/a | No intent to implement. |
| repair | n/a | No intent to implement. |
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
git-wt
command
git-wt is a helper for Git to manage worktrees as part of a development flow.
|
git-wt is a helper for Git to manage worktrees as part of a development flow. |
|
internal
|
|
|
cmn
Package cmn implements common variables and utility functions for git-wt, providing debug and configuration.
|
Package cmn implements common variables and utility functions for git-wt, providing debug and configuration. |
|
cobra/cl
Package cl implements the cl subcommand for git-wt.
|
Package cl implements the cl subcommand for git-wt. |
|
cobra/ls
Package list implements the list subcommand for git-wt.
|
Package list implements the list subcommand for git-wt. |
|
cobra/mk
Package mk implements the mk subcommand for git-wt.
|
Package mk implements the mk subcommand for git-wt. |
|
cobra/mv
Package mv implements the mv subcommand for git-wt.
|
Package mv implements the mv subcommand for git-wt. |
|
cobra/rm
Package rm implements the rm subcommand for git-wt.
|
Package rm implements the rm subcommand for git-wt. |
|
cobra/root
Package root implements the root command for git-wt.
|
Package root implements the root command for git-wt. |
|
cobra/xx
Package xx implements the xx subcommand for git-wt.
|
Package xx implements the xx subcommand for git-wt. |
|
git
Package git implements abstraction to the module git-module.
|
Package git implements abstraction to the module git-module. |
Click to show internal directories.
Click to hide internal directories.