Difference between revisions of "Glab --help"

From wikieduonline
Jump to navigation Jump to search
(Created page with "{{lc}} == See also == * {{glab}} * {{GitLab}} Category:GitLab")
 
Line 1: Line 1:
 
{{lc}}
 
{{lc}}
 +
<pre>
 +
GLab is an open source GitLab CLI tool bringing GitLab to your command line
  
 +
USAGE
 +
  glab <command> <subcommand> [flags]
 +
 +
CORE COMMANDS
 +
  alias:      Create, list and delete aliases
 +
  api:        Make an authenticated request to GitLab API
 +
  auth:        Manage glab's authentication state
 +
  check-update: Check for latest glab releases
 +
  ci:          Work with GitLab CI pipelines and jobs
 +
  completion:  Generate shell completion scripts
 +
  config:      Set and get glab settings
 +
  help:        Help about any command
 +
  issue:      Work with GitLab issues
 +
  label:      Manage labels on remote
 +
  mr:          Create, view and manage merge requests
 +
  release:    Manage GitLab releases
 +
  repo:        Work with GitLab repositories and projects
 +
  ssh-key:    Manage SSH keys
 +
  user:        Interact with user
 +
  variable:    Manage GitLab Project and Group Variables
 +
  version:    show glab version information
 +
 +
FLAGS
 +
      --help      Show help for command
 +
  -v, --version  show glab version information
 +
 +
ENVIRONMENT VARIABLES
 +
  GITLAB_TOKEN: an authentication token for API requests. Setting this avoids being
 +
  prompted to authenticate and overrides any previously stored credentials.
 +
  Can be set in the config with 'glab config set token xxxxxx'
 +
 +
  GITLAB_HOST or GL_HOST: specify the url of the gitlab server if self hosted (eg: https://gitlab.example.com). Default is https://gitlab.com.
 +
 +
  REMOTE_ALIAS or GIT_REMOTE_URL_VAR: git remote variable or alias that contains the gitlab url.
 +
  Can be set in the config with 'glab config set remote_alias origin'
 +
 +
  VISUAL, EDITOR (in order of precedence): the editor tool to use for authoring text.
 +
  Can be set in the config with 'glab config set editor vim'
 +
 +
  BROWSER: the web browser to use for opening links.
 +
  Can be set in the config with 'glab config set browser mybrowser'
 +
 +
  GLAMOUR_STYLE: environment variable to set your desired markdown renderer style
 +
  Available options are (dark|light|notty) or set a custom style
 +
  https://github.com/charmbracelet/glamour#styles
 +
 +
  NO_PROMPT: set to 1 (true) or 0 (false) to disable and enable prompts respectively
 +
 +
  NO_COLOR: set to any value to avoid printing ANSI escape sequences for color output.
 +
 +
  FORCE_HYPERLINKS: set to 1 to force hyperlinks to be output, even when not outputing to a TTY
 +
 +
  GLAB_CONFIG_DIR: set to a directory path to override the global configuration location
 +
 +
LEARN MORE
 +
  Use 'glab <command> <subcommand> --help' for more information about a command.
 +
 +
FEEDBACK
 +
  Encountered a bug or want to suggest a feature?
 +
  Open an issue using 'glab issue create -R profclems/glab'
 +
</pre>
  
 
== See also ==
 
== See also ==

Revision as of 08:12, 27 July 2022

GLab is an open source GitLab CLI tool bringing GitLab to your command line

USAGE
  glab <command> <subcommand> [flags]

CORE COMMANDS
  alias:       Create, list and delete aliases
  api:         Make an authenticated request to GitLab API
  auth:        Manage glab's authentication state
  check-update: Check for latest glab releases
  ci:          Work with GitLab CI pipelines and jobs
  completion:  Generate shell completion scripts
  config:      Set and get glab settings
  help:        Help about any command
  issue:       Work with GitLab issues
  label:       Manage labels on remote
  mr:          Create, view and manage merge requests
  release:     Manage GitLab releases
  repo:        Work with GitLab repositories and projects
  ssh-key:     Manage SSH keys
  user:        Interact with user
  variable:    Manage GitLab Project and Group Variables
  version:     show glab version information

FLAGS
      --help      Show help for command
  -v, --version   show glab version information

ENVIRONMENT VARIABLES
  GITLAB_TOKEN: an authentication token for API requests. Setting this avoids being
  prompted to authenticate and overrides any previously stored credentials.
  Can be set in the config with 'glab config set token xxxxxx'

  GITLAB_HOST or GL_HOST: specify the url of the gitlab server if self hosted (eg: https://gitlab.example.com). Default is https://gitlab.com.

  REMOTE_ALIAS or GIT_REMOTE_URL_VAR: git remote variable or alias that contains the gitlab url.
  Can be set in the config with 'glab config set remote_alias origin'

  VISUAL, EDITOR (in order of precedence): the editor tool to use for authoring text.
  Can be set in the config with 'glab config set editor vim'

  BROWSER: the web browser to use for opening links.
  Can be set in the config with 'glab config set browser mybrowser'

  GLAMOUR_STYLE: environment variable to set your desired markdown renderer style
  Available options are (dark|light|notty) or set a custom style
  https://github.com/charmbracelet/glamour#styles

  NO_PROMPT: set to 1 (true) or 0 (false) to disable and enable prompts respectively

  NO_COLOR: set to any value to avoid printing ANSI escape sequences for color output.

  FORCE_HYPERLINKS: set to 1 to force hyperlinks to be output, even when not outputing to a TTY

  GLAB_CONFIG_DIR: set to a directory path to override the global configuration location

LEARN MORE
  Use 'glab <command> <subcommand> --help' for more information about a command.

FEEDBACK
  Encountered a bug or want to suggest a feature?
  Open an issue using 'glab issue create -R profclems/glab'

See also

Advertising: