Get started¶
Welcome to stackit! This guide will help you get up and running with stacked changes in just a few minutes.
What you'll learn¶
- Installing stackit on your system
- Creating your first stack of branches
- Submitting PRs to GitHub
Before you begin¶
Make sure you have:
- Git 2.25+ installed
- GitHub CLI (
gh) for PR operations - A GitHub repository to work with
Quick walkthrough¶
1. Install stackit¶
brew install getstackit/tap/stackit
2. Initialize in your repository¶
cd your-repository
stackit init
This detects your trunk branch (usually main) and prepares the repo for stacking. You'll be prompted to install optional integrations (GitHub Actions, pre-commit hooks, AI agent files).
3. Create your first branch¶
git add internal/api.go
stackit create add-api -m "feat: add base api"
4. Stack another branch on top¶
git add internal/logic.go
stackit create add-logic -m "feat: implement logic"
5. Visualize the stack¶
stackit log
● add-logic ← you are here
│
◯ add-api
│
main
6. Submit your PRs¶
stackit submit
This pushes both branches and creates two PRs on GitHub, with add-logic correctly pointing its base to add-api.
Next steps¶
Once you're comfortable with the basics, explore:
- Core concepts - Understanding stacks, parents, and children
- Common workflows - Real-world stacking patterns
- Claude integration - AI-assisted stacking