- name
- glab-completion
- description
- Generate shell completion scripts for bash, zsh, fish, or PowerShell. Use when setting up glab autocompletion for your shell. Triggers on completion, autocomplete, shell completion, tab completion.
# glab completion
> **Help provenance.** Each adjacent marker selects its matching source commit and archive SHA-256 below (checksum-verified official macOS arm64 binary). Preserve complete help bytes except trailing spaces/tabs, including casing, spelling, blank lines, indentation, examples, wrapping, and truncation. Historical keys do not override current markers.
> - `2e352a17e`: `2e352a17e7e00bef420b0f38e0ce9ab4e1a38e5d`; `017b14c9bb8d54ba1ea2007607f86dbde0352ad8dea566e2647e9c1bae86bcac`.
## Overview
<!-- help-capture: 2e352a17e:5140c828eca5 -->
````text
This command outputs code meant to be saved to a file, or immediately
evaluated by an interactive shell. To load completions:
### Bash
To load completions in your current shell session:
```shell
source <(glab completion -s bash)
```
To load completions for every new session, run this command one time:
#### Linux
```shell
glab completion -s bash > /etc/bash_completion.d/glab
```
#### macOS
```shell
glab completion -s bash > /usr/local/etc/bash_completion.d/glab
```
### Zsh
If shell completion is not already enabled in your environment you must
enable it. Run this command one time:
```shell
echo "autoload -U compinit; compinit" >> ~/.zshrc
```
To load completions in your current shell session:
```shell
source <(glab completion -s zsh); compdef _glab glab
```
To load completions for every new session, run this command one time:
#### Linux
```shell
glab completion -s zsh > "${fpath[1]}/_glab"
```
#### macOS
For older versions of macOS, you might need this command:
```shell
glab completion -s zsh > /usr/local/share/zsh/site-functions/_glab
```
The Homebrew version of glab should install completions automatically.
### fish
To load completions in your current shell session:
```shell
glab completion -s fish | source
```
To load completions for every new session, run this command one time:
```shell
glab completion -s fish > ~/.config/fish/completions/glab.fish
```
### PowerShell
To load completions in your current shell session:
```shell
glab completion -s powershell | Out-String | Invoke-Expression
```
To load completions for every new session, add the output of the above command
to your PowerShell profile.
When installing glab through a package manager, however, you might not need
more shell configuration to support completions.
For Homebrew, see brew shell completion
USAGE
glab completion [--flags]
EXAMPLES
# Load completions in the current zsh session
source <(glab completion -s zsh); compdef _glab glab
# Print the bash completion script
glab completion -s bash
FLAGS
-h --help Show help for this command.
--no-desc Do not include shell completion description.
-s --shell Shell type: bash, zsh, fish, powershell. (bash)
````
## Command-specific completion
Config completion suggests registered keys, aliases for reads, and typed values. SSH-key get/delete completion queries the current account's key IDs/titles; SSH-key add completes arbitrary paths, so it can suggest a private key. See `glab-config` and `glab-ssh-key` for secret and public-key safeguards. Installing shell integration changes shell behavior and requires approval; do not invoke live completion as an offline test.
## Quick start
```bash
glab completion --help
```
## Subcommands
This command has no subcommands.
View on GitHub