Getting Started

Installation

The easiest way to install so is through Homebrew:

# Install via brew brew install benekuehn/tap/socle

After installation, verify that so is working correctly:

so --version

Creating Your First Stack

Let's create a simple stack of branches. We'll create three branches that depend on each other:

1. Create the first branch

# Start from your main branch git switch main # Create and switch to the first branch so create feature-1

2. Create the second branch

# Make some changes and commit them echo "Feature 1" > feature1.txt git add feature1.txt git commit -m "Add feature 1" # Create the second branch so create feature-2

3. Create the third branch

# Make some changes and commit them echo "Feature 2" > feature2.txt git add feature2.txt git commit -m "Add feature 2" # Create the third branch so create feature-3

Navigating and Submitting Your Stack

Now that we have created our branches, we can navigate up and down in the stack and submit it:

1. Navigate the stack

# Go to the first branch so bottom # Go to the second branch so up # Go to the third branch so top

2. Submit the stack

# From any branch in the stack so submit

This will create draft pull requests for each branch in your stack.

Next Steps

Now that you've created your first stack, you can:

  • Use so log to see your stack
  • Use so up and so down to navigate between branches
  • Use so restack to update your stack when the base branch changes