git-prole-convert(1)

📦 version 0.5.3, in nixos 26.05, nixpkgs unstable

💅 git-prole-convert(1) — the one where we turn your repo into a worktree checkout

okay so bestie, this page lives in the General Commands Manual and it's called git-prole-convert 🎀 — say hi to the manual, she's here to help you glow up your repo situation. let's get into it ✨

🌸 NAME 🌸

git-prole-convert — convert a repository into a worktree checkout 🦋

✨ SYNOPSIS ✨

git-prole convert [--default-branch] [--log] [--dry-run] [--config]
[-h|--help] [DESTINATION]

literally just that. drop it in and let her cook 🔥

💖 DESCRIPTION 💖

Convert a repository into a worktree checkout. that's the whole vibe 💅

so here's the tea — this will convert the repository in the current directory into a worktree repository. and "convert" here is doing a lot of heavy lifting, so let me break down exactly what that includes, no cap:

  • Making the repository a bare repository.
  • Converting the current checkout (branch, commit, whatever it happens to be) into a worktree. Uncommited changes will be kept, but will not remain unstaged 👀 — yes that means what you think it means, heads up.
  • Creating a new worktree for the default branch.

it's giving main character energy for your repo directory. iconic behavior fr fr 👑

🎀 OPTIONS 🎀

  • --default-branch=DEFAULT_BRANCH — a default branch to create a worktree for 🌱
  • --log=LOG [default: info] — log filter directives, of the form `target[span{field=value}]=level`, where all components except the level are optional 🪵 — try `debug` or `trace` if you're nosy like me 👀. 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 📝 — not me doing a vibe check before committing to anything, bestie this is self care 💆‍♀️
  • --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') 🙋‍♀️
  • [DESTINATION] — the directory to place the worktrees into 📦
lowkey important: --dry-run means nothing actually happens, it just constructs and prints a plan. so don't come for me when your repo is still exactly the same afterwards 😭

🦋 SEE ALSO 🦋

(there's no SEE ALSO section on this page — she's the standalone queen she is 💅)

well ok not technically a section but like, this page doesn't have one, so we're just gonna vibe 🫶

huge thanks to the git-prole girlies — this one's sourced from convert, filed under git-prole-convert(1), version + date included in the header up at the top because apparently that's where it lives now 💜 go forth and worktree, bestie. periodt 🌈⭐🍓

📦 where this page comes from