devcontainer-feature.json

{
    "id": "github-cli",
    "version": "1.3.0",
    "name": "GitHub CLI",
    "documentationURL": "https://github.com/devcontainers/features/tree/main/src/github-cli",
    "description": "Installs the GitHub CLI. Auto-detects latest version and installs needed dependencies.",
    "options": {
        "version": {
            "type": "string",
            "proposals": [
                "latest",
                "none"
            ],
            "default": "latest",
            "description": "Select version of the GitHub CLI, if not latest."
        },
        "installDirectlyFromGitHubRelease": {
            "type": "boolean",
            "default": true
        },
        "extensions": {
            "type": "string",
            "default": "",
            "description": "Comma-separated list of GitHub CLI extensions to install (e.g. 'dlvhdr/gh-dash,github/gh-copilot'). Requires either `authOnSetup` or `installExtensionsFromGit` to be true."
        },
        "installExtensionsFromGit": {
            "type": "boolean",
            "default": false,
            "description": "Install `extensions` by cloning their repositories directly instead of using `gh extension install`. Set this to true when `authOnSetup` is false and `extensions` are configured. When used together with `authOnSetup`, git-based installs happen during feature setup instead of waiting for login."
        },
        "authOnSetup": {
            "type": "boolean",
            "default": false,
            "description": "Automatically authenticate with `gh auth login --with-token` when `GH_TOKEN` or `GITHUB_TOKEN` is available, otherwise start `gh auth login` on the first interactive shell if you are not already authenticated. If `extensions` are configured, this must be true unless `installExtensionsFromGit` is true."
        }
    },
    "customizations": {
        "vscode": {
            "settings": {
                "github.copilot.chat.codeGeneration.instructions": [
                    {
                        "text": "This dev container includes the GitHub CLI (`gh`), which is pre-installed and available on the `PATH`. IMPORTANT: `gh api -f` does not support object values, use multiple `-f` flags with hierarchical keys and string values instead. When using GitHub actions `actions/upload-artifact` or `actions/download-artifact` use v4 or later."
                    }
                ]
            }
        }
    },
    "installsAfter": [
        "ghcr.io/devcontainers/features/common-utils",
        "ghcr.io/devcontainers/features/git"
    ]
}