diff --git a/pages/common/glab-alias.md b/pages/common/glab-alias.md index 7b3fad6b39..0eab2b5bba 100644 --- a/pages/common/glab-alias.md +++ b/pages/common/glab-alias.md @@ -1,7 +1,7 @@ # glab alias > Manage GitLab CLI command aliases. -> More information: . +> More information: . - Display the subcommand help: @@ -17,7 +17,7 @@ - Set a shell command as a `glab` subcommand: -`glab alias set --shell {{alias_name}} {{command}}` +`glab alias set {{[-s|--shell]}} {{alias_name}} {{command}}` - Delete a command shortcut: diff --git a/pages/common/glab-auth.md b/pages/common/glab-auth.md index 1ca3fd528b..4986814485 100644 --- a/pages/common/glab-auth.md +++ b/pages/common/glab-auth.md @@ -1,7 +1,7 @@ # glab auth > Authenticate with a GitLab host. -> More information: . +> More information: . - Log in with interactive prompt: @@ -9,7 +9,7 @@ - Log in with a token: -`glab auth login --token {{token}}` +`glab auth login {{[-t|--token]}} {{token}}` - Check authentication status: @@ -17,4 +17,4 @@ - Log in to a specific GitLab instance: -`glab auth login --hostname {{gitlab.example.com}}` +`glab auth login {{[-h|--hostname]}} {{gitlab.example.com}}` diff --git a/pages/common/glab-issue.md b/pages/common/glab-issue.md index adf0a37b26..11dba8fd09 100644 --- a/pages/common/glab-issue.md +++ b/pages/common/glab-issue.md @@ -1,7 +1,7 @@ # glab issue > Manage GitLab issues. -> More information: . +> More information: . - Display a specific issue: @@ -9,7 +9,7 @@ - Display a specific issue in the default web browser: -`glab issue view {{issue_number}} --web` +`glab issue view {{issue_number}} {{[-w|--web]}}` - Create a new issue in the default web browser: @@ -17,11 +17,11 @@ - List the last 10 issues with the `bug` label: -`glab issue list --per-page {{10}} --label "{{bug}}"` +`glab issue list {{[-P|--per-page]}} {{10}} {{[-l|--label]}} "{{bug}}"` - List closed issues made by a specific user: -`glab issue list --closed --author {{username}}` +`glab issue list {{[-c|--closed]}} --author {{username}}` - Reopen a specific issue: diff --git a/pages/common/glab-mr-create.md b/pages/common/glab-mr-create.md index 6160084377..e3453915c0 100644 --- a/pages/common/glab-mr-create.md +++ b/pages/common/glab-mr-create.md @@ -1,7 +1,7 @@ # glab mr create > Manage GitLab merge requests. -> More information: . +> More information: . - Interactively create a merge request: @@ -9,7 +9,7 @@ - Create a merge request, determining the title and description from the commit messages of the current branch: -`glab mr create --fill` +`glab mr create {{[-f|--fill]}}` - Create a draft merge request: @@ -17,8 +17,8 @@ - Create a merge request specifying the target branch, title, and description: -`glab mr create --target-branch {{target_branch}} --title "{{title}}" --description "{{description}}"` +`glab mr create {{[-b|--target-branch]}} {{target_branch}} {{[-t|--title]}} "{{title}}" {{[-d|--description]}} "{{description}}"` - Start opening a merge request in the default web browser: -`glab mr create --web` +`glab mr create {{[-w|--web]}}` diff --git a/pages/common/glab-mr-merge.md b/pages/common/glab-mr-merge.md index d7cc713cfd..163b6ca8ab 100644 --- a/pages/common/glab-mr-merge.md +++ b/pages/common/glab-mr-merge.md @@ -1,7 +1,7 @@ # glab mr merge > Merge GitLab merge requests. -> More information: . +> More information: . - Merge the merge request associated with the current branch interactively: @@ -13,11 +13,11 @@ - Merge the merge request, removing the branch on both the local and the remote: -`glab mr merge --remove-source-branch` +`glab mr merge {{[-d|--remove-source-branch]}}` - Squash the current merge request into one commit with the message body and merge: -`glab mr merge --squash --message="{{commit_message_body}}"` +`glab mr merge {{[-s|--squash]}} {{[-m|--message]}} "{{commit_message_body}}"` - Display help: diff --git a/pages/common/glab-mr.md b/pages/common/glab-mr.md index 0bd4097e7e..66da9cd03e 100644 --- a/pages/common/glab-mr.md +++ b/pages/common/glab-mr.md @@ -2,7 +2,7 @@ > Manage GitLab merge requests. > Some subcommands such as `create` have their own usage documentation. -> More information: . +> More information: . - Create a merge request: diff --git a/pages/common/glab-pipeline.md b/pages/common/glab-pipeline.md index 0d31950c6f..abd5e39314 100644 --- a/pages/common/glab-pipeline.md +++ b/pages/common/glab-pipeline.md @@ -1,7 +1,7 @@ # glab pipeline > List, view, and run GitLab CI/CD pipelines. -> More information: . +> More information: . - View a running pipeline on the current branch: diff --git a/pages/common/glab-release.md b/pages/common/glab-release.md index db99a3f468..06e493122c 100644 --- a/pages/common/glab-release.md +++ b/pages/common/glab-release.md @@ -1,7 +1,7 @@ # glab release > Manage GitLab releases. -> More information: . +> More information: . - List releases in a Gitlab repository, limited to 30 items: diff --git a/pages/common/glab-repo.md b/pages/common/glab-repo.md index e98221d8fe..e668fc91b9 100644 --- a/pages/common/glab-repo.md +++ b/pages/common/glab-repo.md @@ -1,7 +1,7 @@ # glab repo > Work with GitLab repositories. -> More information: . +> More information: . - Create a new repository (if the repository name is not set, the default name will be the name of the current directory): diff --git a/pages/common/glab.md b/pages/common/glab.md index 4dcaa4cb40..e939658168 100644 --- a/pages/common/glab.md +++ b/pages/common/glab.md @@ -2,7 +2,7 @@ > Work seamlessly with GitLab. > Some subcommands such as `config` have their own usage documentation. -> More information: . +> More information: . - Clone a GitLab repository locally: @@ -18,7 +18,7 @@ - View an issue in the default browser: -`glab issue view --web {{issue_number}}` +`glab issue view {{[-w|--web]}} {{issue_number}}` - Create a merge request: @@ -26,7 +26,7 @@ - View a pull request in the default web browser: -`glab mr view --web {{pr_number}}` +`glab mr view {{[-w|--web]}} {{pr_number}}` - Check out a specific pull request locally: