git-prole-add(1)

okay bestie, welcome to the git-prole-add(1) page — yes, that's the General Commands Manual energy, and it's literally all about adding a new worktree 💖 let's get into it 🫶

🎀 NAME 🎀

git-prole-add — add a new worktree ✨

🌈 SYNOPSIS 🌈

git-prole add [-b|--branch] [-B|--force-branch] [-d|--detach] [--log]
[--dry-run] [--config] [-h|--help] [NAME_OR_PATH] [COMMITISH]
[WORKTREE_ADD_ARGS]

✨ DESCRIPTION ✨

Add a new worktree. 💅

This command tries to guess what you want, and as a result the behavior can be a little bit subtle! If given, the --branch argument will always create a new branch, and the COMMITISH argument will always be checked out in the new worktree; use those to disambiguate when necessary.

Unlike git worktree add, this will set new worktrees to start at and track the default branch by default, rather than the checked out commit or branch of the worktree the command is run from. 👑

By default, untracked files are copied to the new worktree. 🦋

💅 OPTIONS 💅

• -b, --branch=BRANCH — create a new branch with the given name instead of checking out an existing branch. This will refuse to reset a branch if it already exists; use --force-branch/-B to reset existing branches. 🎀
• -B, --force-branch=FORCE_BRANCH — create a new branch with the given name, overwriting any existing branch with the same name 🔥
• -d, --detach — create the new worktree in detached mode, not checked out on any branch 💀
• --log=LOG — log filter directives, of the form target[span{field=value}]=level, where all components except the level are optional. Default: info. Try debug or trace. May also be specified with the GIT_PROLE_LOG environment variable. 👀
• --dry-run — if set, do not perform any actions, and instead only construct and print a plan 🧚
• --config=CONFIG — the location to read the configuration file from. Defaults to ~/.config/git-prole/config.toml 🌸
• -h, --help — print help (see a summary with '-h') 🫶
• [NAME_OR_PATH] — the new worktree's name or path. If the name contains a /, it's assumed to be a path. Otherwise, it's assumed to be a worktree name: it's used as a name in the same directory as the other worktrees, and (by default) a branch with that name is checked out or created. (When this is a path, only the last component of the path is used as the branch name.) ✨
• [COMMITISH] — the commit to check out in the new worktree. If this is the name of a unique remote branch, then a local branch with the same name will be created to track the remote branch. 🌈
• [WORKTREE_ADD_ARGS] — extra arguments to forward to git worktree add 💜

okay that's the whole page, bestie — signing off with the footer energy: it's add + git-prole-add(1), so that's the source/version side and the page name, and there's no date listed. periodt 💅✨