Skip to content
This repository has been archived by the owner on Nov 22, 2022. It is now read-only.

Commit

Permalink
docs(update): v1.19.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Aug 10, 2021
1 parent 3dc01da commit b8a02b5
Show file tree
Hide file tree
Showing 11 changed files with 282 additions and 1 deletion.
9 changes: 9 additions & 0 deletions docs/source/completion/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/mr/create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/source/repo/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Subcommands
delete <delete>
fork <fork>
search <search>
view <view>



51 changes: 51 additions & 0 deletions docs/source/repo/view.rst
Original file line number Diff line number Diff line change
@@ -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 [email protected]: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

47 changes: 47 additions & 0 deletions docs/source/ssh-key/add.rst
Original file line number Diff line number Diff line change
@@ -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

36 changes: 36 additions & 0 deletions docs/source/ssh-key/get.rst
Original file line number Diff line number Diff line change
@@ -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

25 changes: 25 additions & 0 deletions docs/source/ssh-key/help.rst
Original file line number Diff line number Diff line change
@@ -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

32 changes: 32 additions & 0 deletions docs/source/ssh-key/index.rst
Original file line number Diff line number Diff line change
@@ -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>



39 changes: 39 additions & 0 deletions docs/source/ssh-key/list.rst
Original file line number Diff line number Diff line change
@@ -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

1 change: 1 addition & 0 deletions docs/source/variable/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Subcommands
:glob:
:maxdepth: 0

list <list>
set <set>


Expand Down
40 changes: 40 additions & 0 deletions docs/source/variable/list.rst
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit b8a02b5

Please sign in to comment.