Command Reference¶

Complete reference for all stackit commands.

Auto-generated content

This page includes auto-generated command documentation from stackit --help.

stackit <command> [flags]

stackit is a command-line tool that makes working with stacked changes fast and intuitive.

abort¶

stackit abort [flags]

absorb¶

stackit absorb [flags]

agent¶

stackit agent [command]

bottom¶

stackit bottom [flags]

checkout¶

stackit checkout [branch] [flags]

children¶

stackit children [flags]

completion¶

stackit completion [command]

config¶

stackit config                    # Interactive TUI

stackit config --list             # Print all config values

stackit config get branch.pattern

stackit config set branch.pattern "{username}/{date}/{message}"

stackit config get submit.footer

stackit config set submit.footer false

stackit config [flags]

stackit config [command]

continue¶

stackit continue [flags]

create¶

stackit create [name] [flags]

debug¶

stackit debug [flags]

delete¶

stackit delete [name] [flags]

doctor¶

stackit doctor [flags]

down¶

stackit down [steps] [flags]

flatten¶

stackit flatten           # Flatten stack from current branch

stackit flatten feature   # Flatten stack from the 'feature' branch

stackit flatten --yes     # Skip confirmation prompt

stackit flatten [branch] [flags]

fold¶

stackit fold [flags]

foreach¶

stackit foreach <command> [args...] [flags]

freeze¶

stackit freeze [branch] [flags]

get¶

stackit get [branch|PR] [flags]

github¶

stackit github [command]

help¶

stackit help [command] [flags]

info¶

stackit info [branch] [flags]

init¶

stackit init [flags]

lock¶

stackit lock [branch] [flags]

log¶

stackit log [flags]

stackit log [command]

main¶

stackit main [flags]

merge¶

stackit merge             # Interactive wizard

stackit merge next        # Merge bottom PR, restack, stop

stackit merge squash      # Consolidate all branches into single PR

stackit merge [flags]

stackit merge [command]

modify¶

stackit modify -a -m "Updated feature"  # Stage all and amend with message

stackit modify -a                       # Stage all and amend (opens editor)

stackit modify -p                       # Interactive patch staging then amend

stackit modify -c -a -m "New commit"    # Create new commit instead of amending

stackit modify --interactive-rebase     # Interactive rebase on branch commits

stackit modify [flags]

move¶

stackit move --onto main           # Move current branch to be a child of main

stackit move --source feature-b --onto feature-a  # Move feature-b onto feature-a

stackit move [flags]

parent¶

stackit parent [flags]

pluck¶

stackit pluck --onto main           # Pluck current branch to be a child of main

stackit pluck --source feat-b --onto feat-x  # Pluck feat-b onto feat-x

stackit pluck [flags]

pop¶

stackit pop [flags]

precommit¶

stackit precommit [command]

prepush¶

stackit prepush [command]

rename¶

stackit rename [name] [flags]

reorder¶

stackit reorder [flags]

restack¶

stackit restack [flags]

scope¶

stackit scope [name] [flags]

shell¶

stackit shell fish | source

stackit shell [command]

split¶

stackit split                                        # Interactive wizard

stackit split --by-hunk                              # Skip type selection

stackit split --by-hunk --below                      # Skip type and direction

stackit split --by-hunk --above                      # Split upstack (child)

stackit split --by-file path/to/file.go             # Extract to parent branch

stackit split --by-file path/to/file.go --as-sibling # Extract to sibling branch

stackit split --by-commit --as-sibling              # Split commits as siblings

stackit split [flags]

squash¶

stackit squash [flags]

submit¶

stackit submit [flags]

sync¶

stackit sync [flags]

top¶

stackit top [flags]

track¶

stackit track [branch] [flags]

trunk¶

stackit trunk [flags]

ui¶

stackit ui [flags]

undo¶

stackit undo [flags]

unfreeze¶

stackit unfreeze [branch] [flags]

unlock¶

stackit unlock [branch] [flags]

untrack¶

stackit untrack [branch] [flags]

up¶

stackit up [steps] [flags]

worktree¶

stackit worktree [command]

Global Flags¶

These flags are available on all stackit commands:

Flag	Description
`--cwd <path>`	Working directory in which to perform operations
`--debug`	Write debug output to the terminal
`--interactive`	Enable interactive features like prompts, pagers, and editors (default: true)
`--no-interactive`	Disable all interactive features
`--verify`	Enable git hooks (pre-commit, etc.) (default: true)
`--no-verify`	Disable git hooks
`--quiet`, `-q`	Minimize output to the terminal (implies `--no-interactive`)