GitHub CLI configuration
Global configuration for the GitHub CLI
**/gh/config.yml**/GitHub CLI/config.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
**/gh/config.yml and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
$schema | string | URI of the JSON Schema used to validate this configuration. https://json-schema.org/understanding-json-schema/reference/schema.html |
version | integer | Internal GitHub CLI configuration format version. https://github.com/cli/cli/blob/v2.96.0/internal/config/config.go default: 1 |
git_protocol | string | Protocol to use for Git operations. https://cli.github.com/manual/gh_config default: "https"one of: "https", "ssh" |
editor | string | null | Text editor command used by GitHub CLI. https://cli.github.com/manual/gh_config default: null |
prompt | string | Whether interactive prompting is enabled. https://cli.github.com/manual/gh_config default: "enabled"one of: "enabled", "disabled" |
prefer_editor_prompt | string | Whether GitHub CLI should prefer opening an editor instead of prompting in the terminal. https://cli.github.com/manual/gh_config default: "disabled"one of: "enabled", "disabled" |
pager | string | null | Terminal pager command used by GitHub CLI. https://cli.github.com/manual/gh_config default: null |
aliases | object | null | GitHub CLI aliases, keyed by alias name with command expansions as values. https://cli.github.com/manual/gh_alias |
http_unix_socket | string | null | Path to a Unix domain socket to use for HTTP connections. https://cli.github.com/manual/gh_config default: null |
browser | string | null | Web browser command used to open URLs. https://cli.github.com/manual/gh_config default: null |
color_labels | string | Whether label colors are displayed using their RGB values. https://cli.github.com/manual/gh_config default: "disabled"one of: "enabled", "disabled" |
accessible_colors | string | Whether the accessible four-bit color palette is enabled. https://cli.github.com/manual/gh_config default: "disabled"one of: "enabled", "disabled" |
accessible_prompter | string | Whether the accessible interactive prompter is enabled. https://cli.github.com/manual/gh_config default: "disabled"one of: "enabled", "disabled" |
spinner | string | Whether terminal spinner animations are enabled. https://cli.github.com/manual/gh_config default: "enabled"one of: "enabled", "disabled" |
telemetry | string | Telemetry mode. The log mode writes telemetry events to stderr instead of sending them. https://cli.github.com/manual/gh_config default: "enabled"one of: "enabled", "disabled", "log" |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 15 properties, 100% carrying a description, max nesting depth 4.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
const | JSON Schema Validation, draft 2020-12 | §6.1.3 — "const" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
format | JSON Schema Validation, draft 2020-12 | §7 — Vocabularies for Semantic Content With "format" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
format: "uri" | RFC 3986 (STD 66) | §3 — Syntax Components |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.