How to Use the Command 'gh config' (with Examples)

The gh config command is an essential tool for configuring the GitHub CLI (Command Line Interface). It allows users to manage various settings and preferences related to their GitHub accounts and workflows directly from the command line. With gh config, users can customize the behavior of the GitHub CLI to suit their needs, whether they are managing Git protocols, setting text editors, or adjusting interactive prompts.

Use case 1: Display what Git protocol is being used

Code:

gh config get git_protocol

Motivation: Understanding which Git protocol is being used can be critical for ensuring secure and efficient communication with GitHub repositories. By checking the protocol, you can verify whether HTTPS or SSH is configured, which might affect both the security posture of your operations and network permissions you need.

Explanation:

• gh config: The command for configuring the GitHub CLI.
• get: Fetches the current value of a setting.
• git_protocol: The specific setting that determines which protocol (HTTPS or SSH) the CLI uses for Git operations.

Example Output:

https

This output indicates that HTTPS is the currently configured protocol for Git operations.

Use case 2: Set protocol to SSH

Code:

gh config set git_protocol ssh

Motivation: Switching the Git protocol to SSH can be beneficial as it typically provides better security through key-based authentication, eliminating the need for password prompts, which is ideal for automated scripts and improved authentication reliability.

Explanation:

• gh config set: This part of the command is used to change a configuration setting.
• git_protocol: The specific setting that determines the protocol for Git operations.
• ssh: The new value to assign to git_protocol, setting it to use SSH.

Example Output: There is no direct output, but you can verify the change with the gh config get git_protocol command.

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: Enhancing the usability and readability of your command line output is crucial, especially when dealing with large quantities of information. Using delta in side-by-side mode can offer a more organized and clear view of differences in outputs from various gh commands.

Explanation:

• gh config set: This part changes a configuration setting.
• pager: Specifies the program or command used to display long outputs.
• 'delta --side-by-side': Sets delta to present differences or logs with a side-by-side comparison, improving the user experience when reviewing command outputs.

Example Output: Similarly, there is no textual output upon setting this, but the effect would be apparent when running commands that have paginated output.

Use case 4: Set text editor to Vim

Code:

gh config set editor vim

Motivation: Choosing Vim as your text editor can greatly enhance your productivity, especially if you’re familiar with its shortcuts and features. Vim is particularly popular among developers for its efficiency and minimalistic interface, which is powerful for editing files within the terminal.

Explanation:

• gh config set: Command to set a configuration value.
• editor: The setting for which the text editor is used for writing or editing comments and other text inputs.
• vim: The choice of text editor, specifying that Vim should be used.

Example Output: No immediate output is produced, but subsequent text edits will default to the Vim editor.

Use case 5: Reset to default text editor

Code:

gh config set editor ""

Motivation: Reverting to the default text editor is sometimes necessary, especially if you need compatibility with default system configurations or if the default editor is better for certain tasks or easier for other users collaborating on the same system.

Explanation:

• gh config set: Command to set a configuration.
• editor: Specifies the editor setting.
• "": An empty string that resets the editor to the CLI’s default settings, which often is the system’s default editor.

Example Output: This command results in no direct terminal output; however, any subsequent edit operations will use the default system editor.

Use case 6: Disable interactive prompts

Code:

gh config set prompt disabled

Motivation: Disabling interactive prompts can be crucial when scripting the GitHub CLI to ensure fully automated workflows that do not require manual inputs or confirmations, aiding in environments where human interaction is limited or not possible.

Explanation:

• gh config set: Used to assign a new value to a configuration.
• prompt: Refers to the configuration controlling user prompts.
• disabled: This value turns off all prompts, enabling non-interactive sessions.

Example Output: There will be no instantaneous output, but the active effect is no prompts appearing during CLI operations.

Use case 7: Set a specific configuration value

Code:

gh config set key value

Motivation: Customizing your GitHub CLI environment by setting specific keys is advantageous for personalized user experience, helping tailor the tool to meet individual or project-specific requirements.

Explanation:

• gh config set: This command changes a value within the configuration.
• key: Represents any configuration key that is customizable.
• value: The corresponding value to assign to that key.

Example Output: Changing a specific configuration value usually doesn’t produce immediate terminal output, but the effect is applied to relevant future operations.

Conclusion:

Configuring the GitHub CLI with gh config enhances the command line experience, enabling users to manage workflow behaviors effectively. Each use case explored demonstrates the flexibility and utility of gh config, providing a functional framework to address a variety of needs that improve interaction with GitHub repositories and streamline development processes.