carapace-sh/carapace-bin / skills/gh
gh
FlaggedUse when working with the GitHub CLI (`gh`) — authentication, repositories, pull requests, issues, releases, GitHub Actions (workflows, runs, caches), the gh API command, extensions, secrets and variables, search, gists, SSH/GPG keys, labels, rulesets, codespaces, browsing, configuration, aliases, JSON output formatting, and environment variables. Triggers on: "gh", "gh auth", "gh repo", "gh pr", "gh issue", "gh release", "gh run", "gh workflow", "gh api", "gh extension", "gh secret", "gh variable", "gh search", "gh gist", "gh label", "gh codespace", "gh browse", "gh status", "gh config", "gh alias", "gh completion", "gh ssh-key", "gh gpg-key", "gh ruleset", "gh cache", "gh org", "GH_TOKEN", "GH_REPO", "GH_HOST", "gh pr create", "gh pr checkout", "gh pr merge", "gh repo clone", "gh repo create", "gh issue create", "gh release create", "gh workflow run", "gh run list", "gh api graphql", "gh extension install", "gh secret set", "gh search repos".
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 9.8 KB |
| references/actions.md | markdown | 10.1 KB |
| references/api.md | markdown | 6.5 KB |
| references/auth.md | markdown | 7.4 KB |
| references/browse-status.md | markdown | 5.6 KB |
| references/config.md | markdown | 8.3 KB |
| references/extension.md | markdown | 5.4 KB |
| references/gist-keys.md | markdown | 9.3 KB |
| references/issue.md | markdown | 9.9 KB |
| references/output-formatting.md | markdown | 5.2 KB |
| references/pr.md | markdown | 14.2 KB |
| references/release.md | markdown | 8.3 KB |
| references/repo.md | markdown | 10.3 KB |
| references/search.md | markdown | 10.7 KB |
| references/secret-variable.md | markdown | 7.0 KB |
references/extension.md
View on GitHub# Extensions
How to install, create, manage, search for, and browse gh extensions.
## Overview
gh extensions are repositories that provide additional gh commands. An extension repository must:
- Start with `gh-` in its name
- Contain an executable of the same name
All arguments passed to `gh <extname>` are forwarded to the `gh-<extname>` executable.
**Key behaviors**:
- An extension **cannot override** core gh commands. If a name conflicts, use `gh extension exec <extname>`.
- When executed, gh checks for new versions once every 24 hours and displays an upgrade notice.
- Extensions are **not verified, signed, or endorsed** by GitHub. Review source before installing.
For available extensions, see <https://github.com/topics/gh-extension>.
## Commands
### `gh extension install`
Install a gh extension from a GitHub or local repository. Aliased via `gh ext install`.
```sh
$ gh extension install owner/gh-extension
$ gh extension install https://my.ghes.com/owner/gh-extension
$ gh extension install . # local repo (development)
```
| Flag | Description |
|------|-------------|
| `--force` | Force upgrade, or ignore if latest already installed |
| `--pin string` | Pin to a release tag (binary) or commit ref (script) |
**Binary vs script extensions**:
- **Binary**: gh looks for release artifacts (prebuilt binaries). Use `--pin` with a tag.
- **Script**: If no release, the repository is cloned. Use `--pin` with a commit ref.
**Local installation** (`.`): gh manages the extension as a symbolic link to the executable in the repository root. For precompiled extensions, the executable must be built and placed in the root manually.
### `gh extension list`
List installed extension commands. Aliased as `gh ext ls`, `gh extension ls`, `gh extensions ls`.
### `gh extension create`
Create a new extension.
```sh
$ gh extension create # interactive
$ gh extension create foobar # script-based
$ gh extension create --precompiled=go foobar # Go precompiled
$ gh extension create --precompiled=other foobar # non-Go precompiled
```
| Flag | Description |
|------|-------------|
| `--precompiled string` | Create a precompiled extension: `go` or `other` |
### `gh extension remove`
Remove an installed extension. Aliased as `gh ext uninstall`, `gh extension uninstall`, `gh extensions uninstall`.
```sh
$ gh extension remove foobar
```
### `gh extension upgrade`
Upgrade installed extensions.
```sh
$ gh extension upgrade foobar
$ gh extension upgrade --all
$ gh extension upgrade --all --dry-run # show what would upgrade
$ gh extension upgrade --all --force
```
| Flag | Description |
|------|-------------|
| `--all` | Upgrade all extensions |
| `--dry-run` | Only display upgrades |
| `--force` | Force upgrade |
### `gh extension browse`
Interactive TUI for browsing, adding, and removing extensions. Terminal width >100 columns recommended.
```sh
$ gh extension browse
$ gh extension browse --single-column # for screen readers / high zoom
```
| Flag | Description |
|------|-------------|
| `--debug` | Log to `/tmp/extBrowse-*` |
| `-s, --single-column` | Render with one column (accessible) |
### `gh extension search`
Search for gh extensions. Similar to `gh search repos` but focused on extensions.
```sh
$ gh extension search # first 30 by stars
$ gh extension search --limit 300
$ gh extension search branch # matching "branch"
$ gh extension search --owner github
$ gh extension search --sort updated --order asc
$ gh extension search --license MIT
$ gh extension search -w # open in browser
```
| Flag | Description |
|------|-------------|
| `--license strings` | Filter by license type |
| `-L, --limit int` | Max results (default 30) |
| `--order string` | Order: `asc`, `desc` (default `desc`; requires `--sort`) |
| `--owner strings` | Filter on owner |
| `--sort string` | Sort: `forks`, `help-wanted-issues`, `stars`, `updated` (default `best-match`) |
| `-w, --web` | Open in browser |
| `--json` / `--jq` / `--template` | JSON output |
**JSON fields**: `createdAt`, `defaultBranch`, `description`, `forksCount`, `fullName`, `hasDownloads`, `hasIssues`, `hasPages`, `hasProjects`, `hasWiki`, `homepage`, `id`, `isArchived`, `isDisabled`, `isFork`, `isPrivate`, `language`, `license`, `name`, `openIssuesCount`, `owner`, `pushedAt`, `size`, `stargazersCount`, `updatedAt`, `url`, `visibility`, `watchersCount`.
For finer-grained search, use `gh search repos --topic "gh-extension"` with additional qualifiers.
### `gh extension exec`
Execute an installed extension, bypassing name conflicts with core commands.
```sh
$ gh extension exec <extname> [args...]
```
## Aliases
The `gh extension` command has several aliases:
| Alias | Full form |
|-------|-----------|
| `gh ext` | `gh extension` |
| `gh extensions` | `gh extension` |
| `gh ext ls` | `gh extension list` |
| `gh ext uninstall` | `gh extension remove` |
| `gh extension uninstall` | `gh extension remove` |
## Update Notifications
gh checks for extension updates once every 24 hours when an extension is executed. Disable with:
```sh
$ export GH_NO_EXTENSION_UPDATE_NOTIFIER=1
```
## Related
- For environment variables (`GH_NO_EXTENSION_UPDATE_NOTIFIER`), see [config.md](config.md).
- For searching repos (used to find extensions), see [search.md](search.md).
- For JSON output formatting, see [output-formatting.md](output-formatting.md).
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |