Quickstart¶

Get twig working in about two minutes. No config required to start.

1. Install¶

1

brew tap anadinema/tap && brew install twig

1

curl --proto '=https' --tlsv1.2 -sSf https://twig.anadinema.dev/install.sh | bash -s -- --to ~/.local/bin

2. Try it — no config needed¶

twig works out of the box with sensible defaults. Inside any git repo:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# Open the interactive branch picker
twig goto

# Commit with the guided TUI wizard
twig save

# Push current branch
twig push

# See stale local branches eligible for cleanup
twig prune --dry-run

3. Add shell aliases (optional but recommended)¶

Add these to your .zshrc or .bashrc to keep your short-form muscle memory:

1
2
3
4
5

alias gco='twig goto'
alias gdo='twig save'
alias gp='twig push'
alias grt='twig root'
alias gprune='twig prune'

Or use twig's built-in aliases directly:

1
2
3
4
5

twig g    # goto
twig s    # save
twig ps   # push
twig rt   # root
twig pr   # prune

4. Create a config file (optional)¶

twig's defaults cover most cases. Create a config only when you want to customise behaviour.

1

mkdir -p ~/.config/twig

1
2
3
4
5

[save]
ticket_prefixes = ["SHIP", "DEX"]    # auto-detect Jira tickets from branch names

[save.scopes]
pinned = ["api", "infra", "ci"]      # always shown at top of scope picker

That's a typical minimal config. See the full reference for everything available.

5. Enable passthrough (optional)¶

To use twig as a full git replacement — passing unknown commands through to git transparently:

1
2

[passthrough]
enabled = true

Then alias git to twig in your shell:

1

alias git=twig

Now git rebase -i, git stash, git log all continue to work exactly as before.