diff --git a/pages/common/gh-issue.md b/pages/common/gh-issue.md index bb4de1603a53b..061d8288ab250 100644 --- a/pages/common/gh-issue.md +++ b/pages/common/gh-issue.md @@ -3,11 +3,15 @@ > Manage GitHub issues from the command-line. > More information: . -- Print out the issue: +- Display a specific issue: `gh issue view {{issue_number}}` -- Create a new issue in the web browser: +- Display a specific issue in the default web browser: + +`gh issue view {{issue_number}} --web` + +- Create a new issue in the default web browser: `gh issue create --web` @@ -23,6 +27,6 @@ `gh issue status --repo {{owner}}/{{repository}}` -- Reopen an issue: +- Reopen a specific issue: `gh issue reopen {{issue_number}}` diff --git a/pages/common/gh-pr-create.md b/pages/common/gh-pr-create.md index 92508004c8266..d166d50ffc7f6 100644 --- a/pages/common/gh-pr-create.md +++ b/pages/common/gh-pr-create.md @@ -19,6 +19,6 @@ `gh pr create --base {{base_branch}} --title "{{title}}" --body "{{body}}"` -- Start opening a pull request in the browser: +- Start opening a pull request in the default web browser: `gh pr create --web` diff --git a/pages/common/gh-pr.md b/pages/common/gh-pr.md index 5d68e783b944f..dc5eb614d5f4e 100644 --- a/pages/common/gh-pr.md +++ b/pages/common/gh-pr.md @@ -7,15 +7,15 @@ `gh pr create` -- Check out a pull request locally: +- Check out a specific pull request locally: `gh pr checkout {{pr_number}}` -- View the changes made in the PR: +- View the changes made in the pull request for the current branch: `gh pr diff` -- Approve the pull request of the current branch: +- Approve the pull request for the current branch: `gh pr review --approve` @@ -30,3 +30,7 @@ - Edit the base branch of a pull request: `gh pr edit --base {{branch_name}}` + +- Check the status of the current repository's pull requests: + +`gh pr status` diff --git a/pages/common/gh-repo.md b/pages/common/gh-repo.md index 3ee1bd0315854..7092683b18ad5 100644 --- a/pages/common/gh-repo.md +++ b/pages/common/gh-repo.md @@ -15,7 +15,7 @@ `gh repo fork {{owner}}/{{repository}} --clone` -- View a repository in the web browser: +- View a repository in the default web browser: `gh repo view {{repository}} --web` diff --git a/pages/common/gh.md b/pages/common/gh.md index ab5ad95296e70..2e8a6887d1f61 100644 --- a/pages/common/gh.md +++ b/pages/common/gh.md @@ -16,7 +16,7 @@ `gh issue list` -- View an issue in the browser: +- View an issue in the default web browser: `gh issue view --web {{issue_number}}` @@ -24,11 +24,11 @@ `gh pr create` -- View a pull request in the browser: +- View a pull request in the default web browser: `gh pr view --web {{pr_number}}` -- Locally check out the branch of a pull request, given its number: +- Check out a specific pull request locally: `gh pr checkout {{pr_number}}` diff --git a/pages/common/glab-alias.md b/pages/common/glab-alias.md index 2f9a540438420..93d646e8626c3 100644 --- a/pages/common/glab-alias.md +++ b/pages/common/glab-alias.md @@ -13,7 +13,7 @@ - Create a `glab` subcommand alias: -`glab alias set {{pv}} '{{pr view}}'` +`glab alias set {{mrv}} '{{mr view}}'` - Set a shell command as a `glab` subcommand: diff --git a/pages/common/glab-issue.md b/pages/common/glab-issue.md index ff2d38957d978..04ded5cc83e9c 100644 --- a/pages/common/glab-issue.md +++ b/pages/common/glab-issue.md @@ -7,6 +7,10 @@ `glab issue view {{issue_number}}` +- Display a specific issue in the default web browser: + +`glab issue view {{issue_number}} --web` + - Create a new issue in the default web browser: `glab issue create --web` diff --git a/pages/common/glab-mr.md b/pages/common/glab-mr.md index 9f1ab66c3905e..befb918f10651 100644 --- a/pages/common/glab-mr.md +++ b/pages/common/glab-mr.md @@ -8,7 +8,7 @@ `glab mr create` -- Check out a merge request locally: +- Check out a specific merge request locally: `glab mr checkout {{mr_number}}` diff --git a/pages/common/glab-repo.md b/pages/common/glab-repo.md index 22498592b2dbd..fc18081b9d130 100644 --- a/pages/common/glab-repo.md +++ b/pages/common/glab-repo.md @@ -15,7 +15,7 @@ `glab repo fork {{owner}}/{{repository}} --clone` -- View a repository in the web browser: +- View a repository in the default web browser: `glab repo view {{owner}}/{{repository}} --web` diff --git a/pages/common/glab.md b/pages/common/glab.md index 5ce18502b8913..474fdfdaf26b3 100644 --- a/pages/common/glab.md +++ b/pages/common/glab.md @@ -1,28 +1,33 @@ # glab -> GitLab CLI tool to help working with GitLab from the command-line. +> Work seamlessly with GitLab from the command-line. +> Some subcommands such as `glab config` have their own usage documentation. > More information: . -- Create a merge request: - -`glab mr create` +- Clone a GitLab repository locally: -- List merge requests: - -`glab mr list` +`glab repo clone {{owner}}/{{repository}}` - Create a new issue: `glab issue create` -- View and filter the current repository's open issues: +- View and filter the open issues of the current repository: `glab issue list` -- List pipelines: +- View an issue in the default browser: + +`glab issue view --web {{issue_number}}` + +- Create a merge request: + +`glab mr create` + +- View a pull request in the default web browser: -`glab pipeline list` +`glab mr view --web {{pr_number}}` -- Clone a repository into a specific directory: +- Check out a specific pull request locally: -`glab repo clone {{user}}/{{repository}} {{directory}}` +`glab mr checkout {{pr_number}}`