How to use the command "gh config" (with examples)
The “gh config” command is used to manage the configuration settings for the GitHub CLI. It allows users to change various settings such as the Git protocol, pager, text editor, and more. This article will illustrate each of the different use cases of the command.
Use case 1: Display what Git protocol is being used
Code:
gh config get git_protocol
Motivation: This use case is helpful when you want to check the current Git protocol being used in the GitHub CLI. It can be useful to verify if SSH or HTTPS is being used.
Explanation: The command “gh config get git_protocol” fetches the current Git protocol setting from the GitHub CLI configuration.
Example output:
https
Use case 2: Set protocol to SSH
Code:
gh config set git_protocol ssh
Motivation: By setting the Git protocol to SSH, you can ensure that all Git operations performed by the GitHub CLI use the secure SSH protocol. This is beneficial for users who prefer to authenticate using SSH keys.
Explanation: The command “gh config set git_protocol ssh” sets the Git protocol to SSH in the GitHub CLI configuration.
Example output: None
Use case 3: Use “delta” in side-by-side mode as the default pager for all “gh” commands
Code:
gh config set pager 'delta --side-by-side'
Motivation: This use case is handy for developers who want to enhance their CLI experience by using a more powerful and visually appealing pager. “delta” is a popular pager that provides side-by-side diff view, syntax highlighting, and more.
Explanation: The command “gh config set pager ‘delta –side-by-side’” configures the GitHub CLI to use “delta” with the “–side-by-side” option as the default pager for all “gh” commands.
Example output: None
Use case 4: Set text editor to Vim
Code:
gh config set editor vim
Motivation: By setting the text editor to Vim, you can conveniently edit GitHub-related files and commit messages directly from the CLI using your preferred editor. Vim is a widely used text editor known for its powerful features and extensibility.
Explanation: The command “gh config set editor vim” configures the GitHub CLI to use Vim as the default text editor.
Example output: None
Use case 5: Reset to default text editor
Code:
gh config set editor ""
Motivation: If you had previously set a custom text editor and now want to revert back to the default text editor, you can use this use case to reset it.
Explanation: The command “gh config set editor "” resets the GitHub CLI to use the default text editor.
Example output: None
Use case 6: Disable interactive prompts
Code:
gh config set prompt disabled
Motivation: Disabling interactive prompts is useful when you want to automate certain tasks or workflows that involve the GitHub CLI. It allows you to perform actions without manual intervention.
Explanation: The command “gh config set prompt disabled” configures the GitHub CLI to disable interactive prompts.
Example output: None
Use case 7: Set a specific configuration value
Code:
gh config set key value
Motivation: This use case allows you to modify or add specific configuration values to the GitHub CLI configuration. It can be useful when you want to customize the behavior of certain features or enable experimental options.
Explanation: The command “gh config set key value” sets a specific configuration value in the GitHub CLI configuration. Replace “key” with the desired configuration key and “value” with the corresponding value.
Example output: None
Conclusion
The “gh config” command provides a way to manage the configuration settings for the GitHub CLI. With the various use cases mentioned in this article, you can customize the behavior of the CLI to suit your needs and preferences. Whether it’s changing the Git protocol, configuring a different pager, or setting a preferred text editor, the “gh config” command gives you the flexibility to personalize your GitHub CLI experience.
