Skip to content

Docs site for stacks #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skarim merged 12 commits into from
Apr 8, 2026
Merged

Docs site for stacks #8

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
214b90e
init docs site
skarim Mar 26, 2026
d5e3c82
add noindex
skarim Mar 26, 2026
a3058ea
clearer examples for init in docs
skarim Mar 27, 2026
c270888
document alias cmd
skarim Mar 29, 2026
3c30dae
updates for latest cmd changes
skarim Apr 3, 2026
3e9f9fd
basic ui walkthrough
skarim Apr 3, 2026
fe887eb
repo housekeeping
skarim Apr 8, 2026
f100cfc
more faq content
skarim Apr 8, 2026
08dc2da
rm test workflow
skarim Apr 8, 2026
8f0d62c
docs cleanup suggestions from code review
skarim Apr 8, 2026
55533a7
rm robots.txt
skarim Apr 8, 2026
b1eb040
fix order of flags and args in cli reference
skarim Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix order of flags and args in cli reference
  • Loading branch information
@skarim
skarim committed Apr 8, 2026
commit b1eb0404a739b46afbd40e70e822d9fa23ed3438
10 changes: 5 additions & 5 deletions docs/src/content/docs/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Requires the [GitHub CLI](https://cli.github.com/) (`gh`) v2.0+.
Initialize a new stack in the current repository.

```sh
gh stack init [branches...] [flags]
gh stack init [flags] [branches...]
```

Creates an entry in `.git/gh-stack` to track stack state. In interactive mode (no arguments), prompts you to name branches and offers to use the current branch as the first layer. You'll also be prompted to set an optional branch prefix. When a prefix is set, branch names you enter are automatically prefixed.
Expand Down Expand Up @@ -67,7 +67,7 @@ gh stack init -p feat --numbered
Add a new branch on top of the current stack.

```sh
gh stack add [branch] [flags]
gh stack add [flags] [branch]
```

Creates a new branch at the current HEAD, adds it to the top of the stack, and checks it out. Must be run while on the topmost branch of a stack. If no branch name is given, prompts for one.
Expand Down Expand Up @@ -214,7 +214,7 @@ gh stack sync
Pull from remote and do a cascading rebase across the stack.

```sh
gh stack rebase [branch] [flags]
gh stack rebase [flags] [branch]
```

Fetches the latest changes from `origin`, then ensures each branch in the stack has the tip of the previous layer in its commit history. Rebases branches in order from trunk upward.
Expand Down Expand Up @@ -346,7 +346,7 @@ Checks out the branch closest to the trunk.
Create a short command alias so you can type less.

```sh
gh stack alias [name] [flags]
gh stack alias [flags] [name]
```

Installs a small wrapper script into `~/.local/bin/` that forwards all arguments to `gh stack`. The default alias name is `gs`, but you can choose any name by passing it as an argument. After setup, you can run `gs push` instead of `gh stack push`.
Expand All @@ -369,7 +369,7 @@ gh stack alias gst

# Remove an alias
gh stack alias --remove
gh stack alias gst --remove
gh stack alias --remove gst
```

### `gh stack feedback`
Expand Down
Loading