Title: Theory / Important / CS / Development / GitHub / CLI
Tags: automatedNewLineAfterCommaSpace

Name: GitHub CLI
Definition: Tool for using GitHub from your computer's command line.
Page: https://docs.github.com/en/github-cli/github-cli/about-github-cli
Context: Github

Instruction: gh
Page: https://docs.github.com/en/github-cli/github-cli/about-github-cli
Effect: github command line
Language: sh

Fla: auth login
Effect: authenticate to github asking login in web based flow or using GITHUB_TOKEN environment variable
Page: https://docs.github.com/en/github-cli/github-cli/about-github-cli
https://cli.github.com/manual/
Prefix: gh

Fla: config set var value
Effect: set the configuration var to value
Page: https://docs.github.com/en/github-cli/github-cli/about-github-cli
Prefix: gh

Fla: alias set name value
Effect: create an alias `gh name` to value
Page: https://docs.github.com/en/github-cli/github-cli/about-github-cli
Prefix: gh

Instruction: gh
Page: https://docs.github.com/en/github-cli/github-cli/github-cli-reference
Effect: list top-level GitHub CLI commands
Language: sh

Fla: top_level_command
Effect: list all option of `gh top_level_command`
Page: https://docs.github.com/en/github-cli/github-cli/github-cli-reference
Prefix: gh

Fla: environement
Effect: List the environment variables that can be used with GitHub CLI
Page: https://docs.github.com/en/github-cli/github-cli/github-cli-reference
Prefix: gh

Fla: config
Effect: the configuration settings that can be used with GitHub CLI
Page: https://docs.github.com/en/github-cli/github-cli/github-cli-reference
Prefix: gh

Fla: list
Effect: list recent workflow runs
Page: https://cli.github.com/manual/gh_actions
Prefix: gh run

Fla: view
Effect: View details for a workflow run or one of its jobs
Page: https://cli.github.com/manual/gh_actions
Prefix: gh run

Fla: watch
Effect: Watch a workflow run while it executes
Page: https://cli.github.com/manual/gh_actions
Prefix: gh run

Fla: rerun
Effect: Rerun a failed workflow run
Page: https://cli.github.com/manual/gh_actions
Prefix: gh run

Fla: download
Effect: Download artifacts generated by runs
Page: https://cli.github.com/manual/gh_actions
Prefix: gh run

Fla: list
Effect: List all the workflow files in your repository
Page: https://cli.github.com/manual/gh_actions
Prefix: gh workflow

Fla: view
Page: https://cli.github.com/manual/gh_actions
Prefix: gh workflow
Print: View details for a workflow file

Fla: enable
Page: https://cli.github.com/manual/gh_actions
Prefix: gh workflow
Print: enable a workflow file

Fla: disable
Page: https://cli.github.com/manual/gh_actions
Prefix: gh workflow
Print: disable a workflow file

Fla: run
Page: https://cli.github.com/manual/gh_actions
Prefix: gh workflow
Print: Trigger a workflow_dispatch run for a workflow file

Fla: list
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh alias
Print: all of the aliases gh is configured to use.

Fla: delete name
Effect: delete alias name
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh alias

Fla: --hostname host
Effect: use github instance host
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh auth login/logout/refresh/setup-git/status
Flag abbreviation: -h host

Fla: --scope scope
Effect: Additional authentication scopes for gh to have
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh auth login/refresh
Flag abbreviation: -s scope

Fla: --web
Effect: open a browser to authenticate
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh auth login
Flag abbreviation: -w

Fla: --with-token
Effect: read token from standard input
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh auth login

Fla: logout
Effect: Remove authentication for a GitHub host specified interactively
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh auth

Fla: refresh
Effect: Expand or fix the permission scopes for stored credentials
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh auth

Fla: setup-git
Effect: Configure git to use GitHub CLI as a credential helper
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh auth

Fla: status
Effect: Verifies and displays information about your authentication state.
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh auth

Fla: --show-token
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh auth status
Flag abbreviation: -t
Print: display the auth token

Fla: browse
Effect: Open the GitHub repository in the web browser.
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh

Fla: --branch name
Effect: Select another branch by passing in the branch name
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh browse
Flag abbreviation: -b name

Fla: --commit
Effect: open the last commit
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh browse
Flag abbreviation: -c

Fla: --no-browser
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh browse
Flag abbreviation: -n
Print: Print destination URL instead of opening the browser

Fla: --projects
Effect: Open repository projects
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh browse
Flag abbreviation: -p

Fla: --repo [host]/owner/repo
Effect: Select another repository using the [HOST/]OWNER/REPO format
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh browse
Flag abbreviation: -R [host]/owner/repo

Fla: --settings
Effect: Open repository settings
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh browse
Flag abbreviation: -s

Fla: --wiki
Effect: Open repository wiki
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh browse
Flag abbreviation: -w

Fla: codespace
Effect: Connect to and manage your codespaces. todo
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh browse
Flag abbreviation: -w

Fla: complession -s shell
Effect: Generate shell completion scripts for GitHub CLI commands.
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh
Flag abbreviation: -w

Fla: config get name
Effect: get the value of configuration name
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh

Fla: config list
Page: https://cli.github.com/manual/gh_alias_list
Prefix: gh
Print: a list of configuration keys and values

Fla: extension
Effect: deal with gh extensions. todo
Page: https://cli.github.com/manual/gh_extension
Prefix: gh

Fla: gist
Effect: work with github gists
Page: https://cli.github.com/manual/gh_extension
Prefix: gh

Fla: gpg-key
Effect: Manage GPG keys registered with your GitHub account
Page: https://cli.github.com/manual/gh_gpg-key
Prefix: gh

Fla: help foo
Page: https://cli.github.com/manual/gh_gpg-key
Prefix: gh
Print: help for command foo

Fla: issue
Effect: work with github issue.
Page: https://cli.github.com/manual/
Prefix: gh
Extra: todo

Fla: pr
Effect: work with github pull requests
Page: https://cli.github.com/manual/
Prefix: gh
Extra: todo

Fla: release
Effect: manage github releases
Page: https://cli.github.com/manual/
Prefix: gh
Extra: todo

Fla: repo
Effect: work with GitHub repositories
Page: https://cli.github.com/manual/
Prefix: gh
Extra: todo

Fla: run
Effect: List, view, and watch recent workflow runs from GitHub Actions.
Page: https://cli.github.com/manual/
Prefix: gh
Extra: todo

Fla: secret
Effect: deal with secret
Page: https://cli.github.com/manual/
Prefix: gh
Extra: todo

Fla: workflow
Effect: List, view, and run workflows in GitHub Actions.
Page: https://cli.github.com/manual/
Prefix: gh
Extra: todo

Fla: ssh-key
Effect: Manage SSH keys registered with your GitHub account
Page: https://cli.github.com/manual/
Prefix: gh
Extra: todo

Fla: api
Effect: Makes an authenticated HTTP request to the GitHub API and prints the response.
Page: https://cli.github.com/manual/
Prefix: gh
Extra: todo