mirror of https://gitlab.com/gitlab-org/cli.git
docs(update): v1.19.0
This commit is contained in:
parent
3dc01da03d
commit
b8a02b55c6
|
@ -18,6 +18,14 @@ For example, for bash you could add this to your '~/.bash_profile':
|
|||
|
||||
eval "$(glab completion -s bash)"
|
||||
|
||||
Generate a %[1]s_gh%[1]s completion script and put it somewhere in your %[1]s$fpath%[1]s:
|
||||
gh completion -s zsh > /usr/local/share/zsh/site-functions/_gh
|
||||
Ensure that the following is present in your %[1]s~/.zshrc%[1]s:
|
||||
autoload -U compinit
|
||||
compinit -i
|
||||
|
||||
Zsh version 5.7 or later is recommended.
|
||||
|
||||
When installing glab through a package manager, however, it's possible that
|
||||
no additional shell configuration is necessary to gain completion support.
|
||||
For Homebrew, see <https://docs.brew.sh/Shell-Completion>
|
||||
|
@ -32,6 +40,7 @@ Options
|
|||
|
||||
::
|
||||
|
||||
--no-desc Do not include shell completion description
|
||||
-s, --shell string Shell type: {bash|zsh|fish|powershell} (default "bash")
|
||||
|
||||
Options inherited from parent commands
|
||||
|
|
|
@ -23,7 +23,7 @@ Examples
|
|||
$ glab mr new
|
||||
$ glab mr create -a username -t "fix annoying bug"
|
||||
$ glab mr create -f --draft --label RFC
|
||||
$ glab mr create --autofill --yes --web
|
||||
$ glab mr create --fill --yes --web
|
||||
|
||||
|
||||
Options
|
||||
|
|
|
@ -31,6 +31,7 @@ Subcommands
|
|||
delete <delete>
|
||||
fork <fork>
|
||||
search <search>
|
||||
view <view>
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -0,0 +1,51 @@
|
|||
.. _glab_repo_view:
|
||||
|
||||
glab repo view
|
||||
--------------
|
||||
|
||||
View a project/repository
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Display the description and README of a project or open it in the browser.
|
||||
|
||||
::
|
||||
|
||||
glab repo view [repository] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
# view project information for the current directory
|
||||
$ glab repo view
|
||||
|
||||
# view project information of specified name
|
||||
$ glab repo view my-project
|
||||
$ glab repo view user/repo
|
||||
$ glab repo view group/namespace/repo
|
||||
|
||||
# specify repo by full [git] URL
|
||||
$ glab repo view git@gitlab.com:user/repo.git
|
||||
$ glab repo view https://gitlab.company.org/user/repo
|
||||
$ glab repo view https://gitlab.company.org/user/repo.git
|
||||
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-b, --branch string View a specific branch of the repository
|
||||
-w, --web Open a project in the browser
|
||||
|
||||
Options inherited from parent commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--help Show help for command
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
.. _glab_ssh-key_add:
|
||||
|
||||
glab ssh-key add
|
||||
----------------
|
||||
|
||||
Add an SSH key to your GitLab account
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Creates a new SSH key owned by the currently authenticated user.
|
||||
|
||||
The --title flag is always required
|
||||
|
||||
|
||||
::
|
||||
|
||||
glab ssh-key add <title> [key-file] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
# Read ssh key from stdin and upload
|
||||
$ glab ssh-key add -t "my title"
|
||||
|
||||
# Read ssh key from specified key file and upload
|
||||
$ glab ssh-key add ~/.ssh/id_ed25519.pub -t "my title"
|
||||
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-e, --expires-at string The expiration date of the SSH key in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
|
||||
-t, --title string New SSH key's title
|
||||
|
||||
Options inherited from parent commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--help Show help for command
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
.. _glab_ssh-key_get:
|
||||
|
||||
glab ssh-key get
|
||||
----------------
|
||||
|
||||
Gets a single key
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Returns a single SSH key specified by the ID
|
||||
|
||||
::
|
||||
|
||||
glab ssh-key get <key-id> [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
# Get ssh key with ID as argument
|
||||
$ glab ssh-key get 7750633
|
||||
|
||||
# Interactive
|
||||
$ glab ssh-key get
|
||||
|
||||
|
||||
Options inherited from parent commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--help Show help for command
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
.. _glab_ssh-key_help:
|
||||
|
||||
glab ssh-key help
|
||||
-----------------
|
||||
|
||||
Help about any command
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Help provides help for any command in the application.
|
||||
Simply type ssh-key help [path to command] for full details.
|
||||
|
||||
::
|
||||
|
||||
glab ssh-key help [command] [flags]
|
||||
|
||||
Options inherited from parent commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--help Show help for command
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
.. _glab_ssh-key:
|
||||
|
||||
glab ssh-key
|
||||
------------
|
||||
|
||||
Manage SSH keys
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Manage SSH keys registered with your GitLab account
|
||||
|
||||
Options inherited from parent commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--help Show help for command
|
||||
|
||||
Subcommands
|
||||
~~~~~~~~~~~
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 0
|
||||
|
||||
add <add>
|
||||
get <get>
|
||||
list <list>
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
.. _glab_ssh-key_list:
|
||||
|
||||
glab ssh-key list
|
||||
-----------------
|
||||
|
||||
Lists currently authenticated user’s SSH keys
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Get a list of currently authenticated user’s SSH keys
|
||||
|
||||
::
|
||||
|
||||
glab ssh-key list [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
$ glab ssh-key list
|
||||
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--show-id Show IDs of SSH Keys
|
||||
|
||||
Options inherited from parent commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--help Show help for command
|
||||
|
|
@ -31,6 +31,7 @@ Subcommands
|
|||
:glob:
|
||||
:maxdepth: 0
|
||||
|
||||
list <list>
|
||||
set <set>
|
||||
|
||||
|
||||
|
|
|
@ -0,0 +1,40 @@
|
|||
.. _glab_variable_list:
|
||||
|
||||
glab variable list
|
||||
------------------
|
||||
|
||||
List project or group variables
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
List project or group variables
|
||||
|
||||
::
|
||||
|
||||
glab variable list [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
$ glab variable list
|
||||
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-g, --group string List group variables
|
||||
|
||||
Options inherited from parent commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--help Show help for command
|
||||
-R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL
|
||||
|
Loading…
Reference in New Issue