Skip to content

Update from code changes: PR support on GitLab, Gitea, Forgejo #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

Open
mintlify wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update from code changes: PR support on GitLab, Gitea, Forgejo #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4b9343
docs: document pull request support for GitLab, Gitea, and Forgejo
mintlify[bot] Sep 3, 2026
00495c7
docs: shorten pr page description to fit search snippet limit
mintlify[bot] Sep 3, 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
25 changes: 18 additions & 7 deletions commands/pr.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
title: "Create and review GitHub pull requests with commitdog pr"
title: "Create and review pull requests with commitdog pr"
sidebarTitle: "pull request"
description: "Open PRs from feature branches with a diff viewer, or list, review, and merge open PRs from main — all from the terminal. GitHub only."
description: "Create pull requests from feature branches with a diff viewer, then list, review, and merge them from main on GitHub, GitLab, Gitea, or Forgejo."
icon: "git-pull-request"
---

`commitdog pr` does different things depending on which branch you are on. On a feature branch it walks you through creating a pull request: you review a diff, enter a title and description, and commitdog creates the PR and opens it in your browser. On `main` or `master` it fetches all open PRs, lets you navigate them with keyboard shortcuts, view their diffs, and merge or close them without leaving the terminal.

`commitdog pr` works with GitHub, GitLab, Gitea, and Forgejo. It targets your project's primary platform, which is set during `commitdog init` and stored in the `.commitdog` file. If no primary platform is set, commitdog uses GitHub. On GitLab, the same flow creates and merges merge requests instead of pull requests.

<Note>
`commitdog pr` works with GitHub only. Configure your GitHub token with `commitdog setup` before using this command.
Configure a token for your platform with `commitdog setup` before using this command. If commitdog does not find a token for the project's platform, it exits with an error telling you to run `commitdog setup`.
</Note>

## Usage
Expand Down Expand Up @@ -40,7 +42,7 @@ The behavior is determined automatically by your current branch.
```
</Step>
<Step title="PR is created and opened">
commitdog calls the GitHub API and prints the PR number and URL:
commitdog calls your platform's API and prints the PR number and URL:

```text
✓ PR #42 created
Expand All @@ -50,13 +52,22 @@ The behavior is determined automatically by your current branch.
```

Press Enter or `y` to open the PR in your default browser.

On GitLab, commitdog creates a merge request and prints it with GitLab's `!` numbering:

```text
✓ MR !42 created
https://gitlab.com/you/repo/-/merge_requests/42

open in browser? [Y/n] ›
```
</Step>
</Steps>
</Tab>
<Tab title="Main branch">
## Reviewing PRs

When you run `commitdog pr` on `main` or `master`, commitdog fetches all open PRs and displays them in a scrollable list:
When you run `commitdog pr` on `main` or `master`, commitdog fetches all open PRs (or merge requests on GitLab) and displays them in a scrollable list:

```text
open PRs — you/repo
Expand All @@ -77,7 +88,7 @@ The behavior is determined automatically by your current branch.

### Merging a PR

Pressing `m` on a selected PR opens the merge method picker:
Pressing `m` on a selected PR opens the merge method picker. All four platforms offer the same three methods. On GitLab, the rebase option calls GitLab's rebase API instead of a merge.

```text
merge PR #42 — feat(auth): add refreshToken and verifyToken
Expand All @@ -97,7 +108,7 @@ The behavior is determined automatically by your current branch.
delete feat/auth branch? [Y/n] ›
```

Selecting yes deletes both the remote branch (via the GitHub API) and the local branch. commitdog then checks out the base branch and pulls the latest changes automatically:
Selecting yes deletes both the remote branch (via your platform's API) and the local branch. commitdog then checks out the base branch and pulls the latest changes automatically:

```text
pulling main...
Expand Down
8 changes: 4 additions & 4 deletions reference/platforms.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ commitdog works with four Git hosting platforms: GitHub, GitLab, Gitea, and Forg
| Create repo (`init`) | ✓ | ✓ | ✓ | ✓ |
| Branch management | ✓ | ✓ | ✓ | ✓ |
| Sync with auto-recovery | ✓ | ✓ | ✓ | ✓ |
| Pull requests (`pr`) | ✓ | — | — | — |
| Pull requests (`pr`) | ✓ | ✓ | ✓ | ✓ |
| Releases with assets | ✓ | ✓ | ✓ | ✓ |
| Self-hosted instance | — | ✓ | ✓ | ✓ |

Expand Down Expand Up @@ -56,7 +56,7 @@ commitdog works with four Git hosting platforms: GitHub, GitLab, Gitea, and Forg

**Releases:** commitdog uploads build artifacts to GitLab's Generic Packages registry, then creates a Release with links to those package assets.

**Merge requests:** Not currently supported. Use your GitLab web interface to open and merge merge requests.
**Merge requests:** Supported. On a feature branch, `commitdog pr` opens an interactive diff viewer and creates a merge request. On `main`, it lists open MRs for you to review, merge (merge, squash, or rebase), or close. Merge requests are numbered with GitLab's `!` prefix, and the rebase option uses GitLab's rebase API.
</Tab>
<Tab title="Gitea">
**Token type:** Personal access token
Expand All @@ -75,7 +75,7 @@ commitdog works with four Git hosting platforms: GitHub, GitLab, Gitea, and Forg

**Releases:** commitdog uploads assets in batches of four to stay within Gitea's API limits, pausing between batches to avoid rate limiting.

**Pull requests:** Not currently supported. Use your Gitea web interface to open and merge pull requests.
**Pull requests:** Supported. On a feature branch, `commitdog pr` opens an interactive diff viewer and creates a PR. On `main`, it lists open PRs for you to review, merge (merge, squash, or rebase), or close.
</Tab>
<Tab title="Forgejo">
**Token type:** Personal access token
Expand All @@ -94,7 +94,7 @@ commitdog works with four Git hosting platforms: GitHub, GitLab, Gitea, and Forg

**Releases:** commitdog uploads assets in batches of four, with a pause between batches.

**Pull requests:** Not currently supported. Use your Forgejo web interface to open and merge pull requests.
**Pull requests:** Supported. On a feature branch, `commitdog pr` opens an interactive diff viewer and creates a PR. On `main`, it lists open PRs for you to review, merge (merge, squash, or rebase), or close.
</Tab>
</Tabs>

Expand Down