Commands Reference
Panqake provides a comprehensive set of commands to manage your branch stack and pull requests, organized here by their function.
Command Aliases
Panqake provides both panqake
and pq
commands. They are functionally identical, with pq
serving as a convenient shorthand.
Command Categories
Panqake commands are organized into four main categories:
Navigation Commands
Used to navigate and visualize your branch stack:
Command | Alias | Description |
---|---|---|
list | ls | Displays all branches in the stack with their relationships |
switch | co | Switches to another branch in the stack |
up | Moves up from current branch to its parent | |
down | Moves down from current branch to a child branch |
Branch Management Commands
Used to create, delete, and manage branches in your stack:
Command | Description |
---|---|
new | Creates a new branch based on your current branch |
delete | Deletes a branch while updating children stack relationships |
rename | Renames a branch while preserving its stack relationships |
track | Adds an existing git branch to your stack |
untrack | Removes a branch from the stack without deleting the Git branch |
Update & Sync Commands
Used to update branches and propagate changes through your stack:
Command | Description |
---|---|
modify | Interactively select files to stage and commit/amend |
update | Rebases all child branches and updates their PRs |
sync | Fetches latest changes from the remote main branch and updates local branches |
Pull Request Operations
Used to manage GitHub pull requests for your branches:
Command | Description |
---|---|
submit | Push changes to remote and optionally create/update PR with current branch changes |
pr | Creates/updates pull requests for branches in the stack |
merge | Merges PR and updates all dependent branches |
Git Passthrough
Any unrecognized commands are transparently passed to vanilla Git, so you can also use standard Git commands within Panqake.
For example, status
is not a valid panqake
command, so it will be passed to Git:
# Running
pq status
# will pass it to git and run:
# git status