Loading source
Pulling the file list, source metadata, and syntax-aware rendering for this listing.
Source from repo
Comprehensive GitHub CLI (gh) reference covering repos, issues, PRs, Actions, projects, releases, and more.
Files
Skill
Size
Entrypoint
Format
Open file
Syntax-highlighted preview of this file as included in the skill package.
SKILL.md
1---2name: gh-cli3description: GitHub CLI (gh) comprehensive reference for repositories, issues, pull requests, Actions, projects, releases, gists, codespaces, organizations, extensions, and all GitHub operations from the command line.4---5# GitHub CLI (gh)7Comprehensive reference for GitHub CLI (gh) - work seamlessly with GitHub from the command line.9**Version:** 2.85.0 (current as of January 2026)11## Prerequisites13### Installation15```bash17# macOS18brew install gh19# Linux21curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg22echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null23sudo apt update24sudo apt install gh25# Windows27winget install --id GitHub.cli28# Verify installation30gh --version31```32### Authentication34```bash36# Interactive login (default: github.com)37gh auth login38# Login with specific hostname40gh auth login --hostname enterprise.internal41# Login with token43gh auth login --with-token < mytoken.txt44# Check authentication status46gh auth status47# Switch accounts49gh auth switch --hostname github.com --user username50# Logout52gh auth logout --hostname github.com --user username53```54### Setup Git Integration56```bash58# Configure git to use gh as credential helper59gh auth setup-git60# View active token62gh auth token63# Refresh authentication scopes65gh auth refresh --scopes write:org,read:public_key66```67## CLI Structure69```71gh # Root command72├── auth # Authentication73│ ├── login74│ ├── logout75│ ├── refresh76│ ├── setup-git77│ ├── status78│ ├── switch79│ └── token80├── browse # Open in browser81├── codespace # GitHub Codespaces82│ ├── code83│ ├── cp84│ ├── create85│ ├── delete86│ ├── edit87│ ├── jupyter88│ ├── list89│ ├── logs90│ ├── ports91│ ├── rebuild92│ ├── ssh93│ ├── stop94│ └── view95├── gist # Gists96│ ├── clone97│ ├── create98│ ├── delete99│ ├── edit100│ ├── list101│ ├── rename102│ └── view103├── issue # Issues104│ ├── create105│ ├── list106│ ├── status107│ ├── close108│ ├── comment109│ ├── delete110│ ├── develop111│ ├── edit112│ ├── lock113│ ├── pin114│ ├── reopen115│ ├── transfer116│ ├── unlock117│ └── view118├── org # Organizations119│ └── list120├── pr # Pull Requests121│ ├── create122│ ├── list123│ ├── status124│ ├── checkout125│ ├── checks126│ ├── close127│ ├── comment128│ ├── diff129│ ├── edit130│ ├── lock131│ ├── merge132│ ├── ready133│ ├── reopen134│ ├── revert135│ ├── review136│ ├── unlock137│ ├── update-branch138│ └── view139├── project # Projects140│ ├── close141│ ├── copy142│ ├── create143│ ├── delete144│ ├── edit145│ ├── field-create146│ ├── field-delete147│ ├── field-list148│ ├── item-add149│ ├── item-archive150│ ├── item-create151│ ├── item-delete152│ ├── item-edit153│ ├── item-list154│ ├── link155│ ├── list156│ ├── mark-template157│ ├── unlink158│ └── view159├── release # Releases160│ ├── create161│ ├── list162│ ├── delete163│ ├── delete-asset164│ ├── download165│ ├── edit166│ ├── upload167│ ├── verify168│ ├── verify-asset169│ └── view170├── repo # Repositories171│ ├── create172│ ├── list173│ ├── archive174│ ├── autolink175│ ├── clone176│ ├── delete177│ ├── deploy-key178│ ├── edit179│ ├── fork180│ ├── gitignore181│ ├── license182│ ├── rename183│ ├── set-default184│ ├── sync185│ ├── unarchive186│ └── view187├── cache # Actions caches188│ ├── delete189│ └── list190├── run # Workflow runs191│ ├── cancel192│ ├── delete193│ ├── download194│ ├── list195│ ├── rerun196│ ├── view197│ └── watch198├── workflow # Workflows199│ ├── disable200│ ├── enable201│ ├── list202│ ├── run203│ └── view204├── agent-task # Agent tasks205├── alias # Command aliases206│ ├── delete207│ ├── import208│ ├── list209│ └── set210├── api # API requests211├── attestation # Artifact attestations212│ ├── download213│ ├── trusted-root214│ └── verify215├── completion # Shell completion216├── config # Configuration217│ ├── clear-cache218│ ├── get219│ ├── list220│ └── set221├── extension # Extensions222│ ├── browse223│ ├── create224│ ├── exec225│ ├── install226│ ├── list227│ ├── remove228│ ├── search229│ └── upgrade230├── gpg-key # GPG keys231│ ├── add232│ ├── delete233│ └── list234├── label # Labels235│ ├── clone236│ ├── create237│ ├── delete238│ ├── edit239│ └── list240├── preview # Preview features241├── ruleset # Rulesets242│ ├── check243│ ├── list244│ └── view245├── search # Search246│ ├── code247│ ├── commits248│ ├── issues249│ ├── prs250│ └── repos251├── secret # Secrets252│ ├── delete253│ ├── list254│ └── set255├── ssh-key # SSH keys256│ ├── add257│ ├── delete258│ └── list259├── status # Status overview260└── variable # Variables261├── delete262├── get263├── list264└── set265```266## Configuration268### Global Configuration270```bash272# List all configuration273gh config list274# Get specific configuration value276gh config list git_protocol277gh config get editor278# Set configuration value280gh config set editor vim281gh config set git_protocol ssh282gh config set prompt disabled283gh config set pager "less -R"284# Clear configuration cache286gh config clear-cache287```288### Environment Variables290```bash292# GitHub token (for automation)293export GH_TOKEN=ghp_xxxxxxxxxxxx294# GitHub hostname296export GH_HOST=github.com297# Disable prompts299export GH_PROMPT_DISABLED=true300# Custom editor302export GH_EDITOR=vim303# Custom pager305export GH_PAGER=less306# HTTP timeout308export GH_TIMEOUT=30309# Custom repository (override default)311export GH_REPO=owner/repo312# Custom git protocol314export GH_ENTERPRISE_HOSTNAME=hostname315```316## Authentication (gh auth)318### Login320```bash322# Interactive login323gh auth login324# Web-based authentication326gh auth login --web327# With clipboard for OAuth code329gh auth login --web --clipboard330# With specific git protocol332gh auth login --git-protocol ssh333# With custom hostname (GitHub Enterprise)335gh auth login --hostname enterprise.internal336# Login with token from stdin338gh auth login --with-token < token.txt339# Insecure storage (plain text)341gh auth login --insecure-storage342```343### Status345```bash347# Show all authentication status348gh auth status349# Show active account only351gh auth status --active352# Show specific hostname354gh auth status --hostname github.com355# Show token in output357gh auth status --show-token358# JSON output360gh auth status --json hosts361# Filter with jq363gh auth status --json hosts --jq '.hosts | add'364```365### Switch Accounts367```bash369# Interactive switch370gh auth switch371# Switch to specific user/host373gh auth switch --hostname github.com --user monalisa374```375### Token377```bash379# Print authentication token380gh auth token381# Token for specific host/user383gh auth token --hostname github.com --user monalisa384```385### Refresh387```bash389# Refresh credentials390gh auth refresh391# Add scopes393gh auth refresh --scopes write:org,read:public_key394# Remove scopes396gh auth refresh --remove-scopes delete_repo397# Reset to default scopes399gh auth refresh --reset-scopes400# With clipboard402gh auth refresh --clipboard403```404### Setup Git406```bash408# Setup git credential helper409gh auth setup-git410# Setup for specific host412gh auth setup-git --hostname enterprise.internal413# Force setup even if host not known415gh auth setup-git --hostname enterprise.internal --force416```417## Browse (gh browse)419```bash421# Open repository in browser422gh browse423# Open specific path425gh browse script/426gh browse main.go:312427# Open issue or PR429gh browse 123430# Open commit432gh browse 77507cd94ccafcf568f8560cfecde965fcfa63433# Open with specific branch435gh browse main.go --branch bug-fix436# Open different repository438gh browse --repo owner/repo439# Open specific pages441gh browse --actions # Actions tab442gh browse --projects # Projects tab443gh browse --releases # Releases tab444gh browse --settings # Settings page445gh browse --wiki # Wiki page446# Print URL instead of opening448gh browse --no-browser449```450## Repositories (gh repo)452### Create Repository454```bash456# Create new repository457gh repo create my-repo458# Create with description460gh repo create my-repo --description "My awesome project"461# Create public repository463gh repo create my-repo --public464# Create private repository466gh repo create my-repo --private467# Create with homepage469gh repo create my-repo --homepage https://example.com470# Create with license472gh repo create my-repo --license mit473# Create with gitignore475gh repo create my-repo --gitignore python476# Initialize as template repository478gh repo create my-repo --template479# Create repository in organization481gh repo create org/my-repo482# Create without cloning locally484gh repo create my-repo --source=.485# Disable issues487gh repo create my-repo --disable-issues488# Disable wiki490gh repo create my-repo --disable-wiki491```492### Clone Repository494```bash496# Clone repository497gh repo clone owner/repo498# Clone to specific directory500gh repo clone owner/repo my-directory501# Clone with different branch503gh repo clone owner/repo --branch develop504```505### List Repositories507```bash509# List all repositories510gh repo list511# List repositories for owner513gh repo list owner514# Limit results516gh repo list --limit 50517# Public repositories only519gh repo list --public520# Source repositories only (not forks)522gh repo list --source523# JSON output525gh repo list --json name,visibility,owner526# Table output528gh repo list --limit 100 | tail -n +2529# Filter with jq531gh repo list --json name --jq '.[].name'532```533### View Repository535```bash537# View repository details538gh repo view539# View specific repository541gh repo view owner/repo542# JSON output544gh repo view --json name,description,defaultBranchRef545# View in browser547gh repo view --web548```549### Edit Repository551```bash553# Edit description554gh repo edit --description "New description"555# Set homepage557gh repo edit --homepage https://example.com558# Change visibility560gh repo edit --visibility private561gh repo edit --visibility public562# Enable/disable features564gh repo edit --enable-issues565gh repo edit --disable-issues566gh repo edit --enable-wiki567gh repo edit --disable-wiki568gh repo edit --enable-projects569gh repo edit --disable-projects570# Set default branch572gh repo edit --default-branch main573# Rename repository575gh repo rename new-name576# Archive repository578gh repo archive579gh repo unarchive580```581### Delete Repository583```bash585# Delete repository586gh repo delete owner/repo587# Confirm without prompt589gh repo delete owner/repo --yes590```591### Fork Repository593```bash595# Fork repository596gh repo fork owner/repo597# Fork to organization599gh repo fork owner/repo --org org-name600# Clone after forking602gh repo fork owner/repo --clone603# Remote name for fork605gh repo fork owner/repo --remote-name upstream606```607### Sync Fork609```bash611# Sync fork with upstream612gh repo sync613# Sync specific branch615gh repo sync --branch feature616# Force sync618gh repo sync --force619```620### Set Default Repository622```bash624# Set default repository for current directory625gh repo set-default626# Set default explicitly628gh repo set-default owner/repo629# Unset default631gh repo set-default --unset632```633### Repository Autolinks635```bash637# List autolinks638gh repo autolink list639# Add autolink641gh repo autolink add \642--key-prefix JIRA- \643--url-template https://jira.example.com/browse/<num>644# Delete autolink646gh repo autolink delete 12345647```648### Repository Deploy Keys650```bash652# List deploy keys653gh repo deploy-key list654# Add deploy key656gh repo deploy-key add ~/.ssh/id_rsa.pub \657--title "Production server" \658--read-only659# Delete deploy key661gh repo deploy-key delete 12345662```663### Gitignore and License665```bash667# View gitignore template668gh repo gitignore669# View license template671gh repo license mit672# License with full name674gh repo license mit --fullname "John Doe"675```676## Issues (gh issue)678### Create Issue680```bash682# Create issue interactively683gh issue create684# Create with title686gh issue create --title "Bug: Login not working"687# Create with title and body689gh issue create \690--title "Bug: Login not working" \691--body "Steps to reproduce..."692# Create with body from file694gh issue create --body-file issue.md695# Create with labels697gh issue create --title "Fix bug" --labels bug,high-priority698# Create with assignees700gh issue create --title "Fix bug" --assignee user1,user2701# Create in specific repository703gh issue create --repo owner/repo --title "Issue title"704# Create issue from web706gh issue create --web707```708### List Issues710```bash712# List all open issues713gh issue list714# List all issues (including closed)716gh issue list --state all717# List closed issues719gh issue list --state closed720# Limit results722gh issue list --limit 50723# Filter by assignee725gh issue list --assignee username726gh issue list --assignee @me727# Filter by labels729gh issue list --labels bug,enhancement730# Filter by milestone732gh issue list --milestone "v1.0"733# Search/filter735gh issue list --search "is:open is:issue label:bug"736# JSON output738gh issue list --json number,title,state,author739# Table view741gh issue list --json number,title,labels --jq '.[] | [.number, .title, .labels[].name] | @tsv'742# Show comments count744gh issue list --json number,title,comments --jq '.[] | [.number, .title, .comments]'745# Sort by747gh issue list --sort created --order desc748```749### View Issue751```bash753# View issue754gh issue view 123755# View with comments757gh issue view 123 --comments758# View in browser760gh issue view 123 --web761# JSON output763gh issue view 123 --json title,body,state,labels,comments764# View specific fields766gh issue view 123 --json title --jq '.title'767```768### Edit Issue770```bash772# Edit interactively773gh issue edit 123774# Edit title776gh issue edit 123 --title "New title"777# Edit body779gh issue edit 123 --body "New description"780# Add labels782gh issue edit 123 --add-label bug,high-priority783# Remove labels785gh issue edit 123 --remove-label stale786# Add assignees788gh issue edit 123 --add-assignee user1,user2789# Remove assignees791gh issue edit 123 --remove-assignee user1792# Set milestone794gh issue edit 123 --milestone "v1.0"795```796### Close/Reopen Issue798```bash800# Close issue801gh issue close 123802# Close with comment804gh issue close 123 --comment "Fixed in PR #456"805# Reopen issue807gh issue reopen 123808```809### Comment on Issue811```bash813# Add comment814gh issue comment 123 --body "This looks good!"815# Edit comment817gh issue comment 123 --edit 456789 --body "Updated comment"818# Delete comment820gh issue comment 123 --delete 456789821```822### Issue Status824```bash826# Show issue status summary827gh issue status828# Status for specific repository830gh issue status --repo owner/repo831```832### Pin/Unpin Issues834```bash836# Pin issue (pinned to repo dashboard)837gh issue pin 123838# Unpin issue840gh issue unpin 123841```842### Lock/Unlock Issue844```bash846# Lock conversation847gh issue lock 123848# Lock with reason850gh issue lock 123 --reason off-topic851# Unlock853gh issue unlock 123854```855### Transfer Issue857```bash859# Transfer to another repository860gh issue transfer 123 --repo owner/new-repo861```862### Delete Issue864```bash866# Delete issue867gh issue delete 123868# Confirm without prompt870gh issue delete 123 --yes871```872### Develop Issue (Draft PR)874```bash876# Create draft PR from issue877gh issue develop 123878# Create in specific branch880gh issue develop 123 --branch fix/issue-123881# Create with base branch883gh issue develop 123 --base main884```885## Pull Requests (gh pr)887### Create Pull Request889```bash891# Create PR interactively892gh pr create893# Create with title895gh pr create --title "Feature: Add new functionality"896# Create with title and body898gh pr create \899--title "Feature: Add new functionality" \900--body "This PR adds..."901# Fill body from template903gh pr create --body-file .github/PULL_REQUEST_TEMPLATE.md904# Set base branch906gh pr create --base main907# Set head branch (default: current branch)909gh pr create --head feature-branch910# Create draft PR912gh pr create --draft913# Add assignees915gh pr create --assignee user1,user2916# Add reviewers918gh pr create --reviewer user1,user2919# Add labels921gh pr create --labels enhancement,feature922# Link to issue924gh pr create --issue 123925# Create in specific repository927gh pr create --repo owner/repo928# Open in browser after creation930gh pr create --web931```932### List Pull Requests934```bash936# List open PRs937gh pr list938# List all PRs940gh pr list --state all941# List merged PRs943gh pr list --state merged944# List closed (not merged) PRs946gh pr list --state closed947# Filter by head branch949gh pr list --head feature-branch950# Filter by base branch952gh pr list --base main953# Filter by author955gh pr list --author username956gh pr list --author @me957# Filter by assignee959gh pr list --assignee username960# Filter by labels962gh pr list --labels bug,enhancement963# Limit results965gh pr list --limit 50966# Search968gh pr list --search "is:open is:pr label:review-required"969# JSON output971gh pr list --json number,title,state,author,headRefName972# Show check status974gh pr list --json number,title,statusCheckRollup --jq '.[] | [.number, .title, .statusCheckRollup[]?.status]'975# Sort by977gh pr list --sort created --order desc978```979### View Pull Request981```bash983# View PR984gh pr view 123985# View with comments987gh pr view 123 --comments988# View in browser990gh pr view 123 --web991# JSON output993gh pr view 123 --json title,body,state,author,commits,files994# View diff996gh pr view 123 --json files --jq '.files[].path'997# View with jq query999gh pr view 123 --json title,state --jq '"\(.title): \(.state)"'1000```1001### Checkout Pull Request1003```bash1005# Checkout PR branch1006gh pr checkout 1231007# Checkout with specific branch name1009gh pr checkout 123 --branch name-1231010# Force checkout1012gh pr checkout 123 --force1013```1014### Diff Pull Request1016```bash1018# View PR diff1019gh pr diff 1231020# View diff with color1022gh pr diff 123 --color always1023# Output to file1025gh pr diff 123 > pr-123.patch1026# View diff of specific files1028gh pr diff 123 --name-only1029```1030### Merge Pull Request1032```bash1034# Merge PR1035gh pr merge 1231036# Merge with specific method1038gh pr merge 123 --merge1039gh pr merge 123 --squash1040gh pr merge 123 --rebase1041# Delete branch after merge1043gh pr merge 123 --delete-branch1044# Merge with comment1046gh pr merge 123 --subject "Merge PR #123" --body "Merging feature"1047# Merge draft PR1049gh pr merge 123 --admin1050# Force merge (skip checks)1052gh pr merge 123 --admin1053```1054### Close Pull Request1056```bash1058# Close PR (as draft, not merge)1059gh pr close 1231060# Close with comment1062gh pr close 123 --comment "Closing due to..."1063```1064### Reopen Pull Request1066```bash1068# Reopen closed PR1069gh pr reopen 1231070```1071### Edit Pull Request1073```bash1075# Edit interactively1076gh pr edit 1231077# Edit title1079gh pr edit 123 --title "New title"1080# Edit body1082gh pr edit 123 --body "New description"1083# Add labels1085gh pr edit 123 --add-label bug,enhancement1086# Remove labels1088gh pr edit 123 --remove-label stale1089# Add assignees1091gh pr edit 123 --add-assignee user1,user21092# Remove assignees1094gh pr edit 123 --remove-assignee user11095# Add reviewers1097gh pr edit 123 --add-reviewer user1,user21098# Remove reviewers1100gh pr edit 123 --remove-reviewer user11101# Mark as ready for review1103gh pr edit 123 --ready1104```1105### Ready for Review1107```bash1109# Mark draft PR as ready1110gh pr ready 1231111```1112### Pull Request Checks1114```bash1116# View PR checks1117gh pr checks 1231118# Watch checks in real-time1120gh pr checks 123 --watch1121# Watch interval (seconds)1123gh pr checks 123 --watch --interval 51124```1125### Comment on Pull Request1127```bash1129# Add comment1130gh pr comment 123 --body "Looks good!"1131# Comment on specific line1133gh pr comment 123 --body "Fix this" \1134--repo owner/repo \1135--head-owner owner --head-branch feature1136# Edit comment1138gh pr comment 123 --edit 456789 --body "Updated"1139# Delete comment1141gh pr comment 123 --delete 4567891142```1143### Review Pull Request1145```bash1147# Review PR (opens editor)1148gh pr review 1231149# Approve PR1151gh pr review 123 --approve --body "LGTM!"1152# Request changes1154gh pr review 123 --request-changes \1155--body "Please fix these issues"1156# Comment on PR1158gh pr review 123 --comment --body "Some thoughts..."1159# Dismiss review1161gh pr review 123 --dismiss1162```1163### Update Branch1165```bash1167# Update PR branch with latest base branch1168gh pr update-branch 1231169# Force update1171gh pr update-branch 123 --force1172# Use merge strategy1174gh pr update-branch 123 --merge1175```1176### Lock/Unlock Pull Request1178```bash1180# Lock PR conversation1181gh pr lock 1231182# Lock with reason1184gh pr lock 123 --reason off-topic1185# Unlock1187gh pr unlock 1231188```1189### Revert Pull Request1191```bash1193# Revert merged PR1194gh pr revert 1231195# Revert with specific branch name1197gh pr revert 123 --branch revert-pr-1231198```1199### Pull Request Status1201```bash1203# Show PR status summary1204gh pr status1205# Status for specific repository1207gh pr status --repo owner/repo1208```1209## GitHub Actions1211### Workflow Runs (gh run)1213```bash1215# List workflow runs1216gh run list1217# List for specific workflow1219gh run list --workflow "ci.yml"1220# List for specific branch1222gh run list --branch main1223# Limit results1225gh run list --limit 201226# JSON output1228gh run list --json databaseId,status,conclusion,headBranch1229# View run details1231gh run view 1234567891232# View run with verbose logs1234gh run view 123456789 --log1235# View specific job1237gh run view 123456789 --job 9876543211238# View in browser1240gh run view 123456789 --web1241# Watch run in real-time1243gh run watch 1234567891244# Watch with interval1246gh run watch 123456789 --interval 51247# Rerun failed run1249gh run rerun 1234567891250# Rerun specific job1252gh run rerun 123456789 --job 9876543211253# Cancel run1255gh run cancel 1234567891256# Delete run1258gh run delete 1234567891259# Download run artifacts1261gh run download 1234567891262# Download specific artifact1264gh run download 123456789 --name build1265# Download to directory1267gh run download 123456789 --dir ./artifacts1268```1269### Workflows (gh workflow)1271```bash1273# List workflows1274gh workflow list1275# View workflow details1277gh workflow view ci.yml1278# View workflow YAML1280gh workflow view ci.yml --yaml1281# View in browser1283gh workflow view ci.yml --web1284# Enable workflow1286gh workflow enable ci.yml1287# Disable workflow1289gh workflow disable ci.yml1290# Run workflow manually1292gh workflow run ci.yml1293# Run with inputs1295gh workflow run ci.yml \1296--raw-field \1297version="1.0.0" \1298environment="production"1299# Run from specific branch1301gh workflow run ci.yml --ref develop1302```1303### Action Caches (gh cache)1305```bash1307# List caches1308gh cache list1309# List for specific branch1311gh cache list --branch main1312# List with limit1314gh cache list --limit 501315# Delete cache1317gh cache delete 1234567891318# Delete all caches1320gh cache delete --all1321```1322### Action Secrets (gh secret)1324```bash1326# List secrets1327gh secret list1328# Set secret (prompts for value)1330gh secret set MY_SECRET1331# Set secret from environment1333echo "$MY_SECRET" | gh secret set MY_SECRET1334# Set secret for specific environment1336gh secret set MY_SECRET --env production1337# Set secret for organization1339gh secret set MY_SECRET --org orgname1340# Delete secret1342gh secret delete MY_SECRET1343# Delete from environment1345gh secret delete MY_SECRET --env production1346```1347### Action Variables (gh variable)1349```bash1351# List variables1352gh variable list1353# Set variable1355gh variable set MY_VAR "some-value"1356# Set variable for environment1358gh variable set MY_VAR "value" --env production1359# Set variable for organization1361gh variable set MY_VAR "value" --org orgname1362# Get variable value1364gh variable get MY_VAR1365# Delete variable1367gh variable delete MY_VAR1368# Delete from environment1370gh variable delete MY_VAR --env production1371```1372## Projects (gh project)1374```bash1376# List projects1377gh project list1378# List for owner1380gh project list --owner owner1381# Open projects1383gh project list --open1384# View project1386gh project view 1231387# View project items1389gh project view 123 --format json1390# Create project1392gh project create --title "My Project"1393# Create in organization1395gh project create --title "Project" --org orgname1396# Create with readme1398gh project create --title "Project" --readme "Description here"1399# Edit project1401gh project edit 123 --title "New Title"1402# Delete project1404gh project delete 1231405# Close project1407gh project close 1231408# Copy project1410gh project copy 123 --owner target-owner --title "Copy"1411# Mark template1413gh project mark-template 1231414# List fields1416gh project field-list 1231417# Create field1419gh project field-create 123 --title "Status" --datatype single_select1420# Delete field1422gh project field-delete 123 --id 4561423# List items1425gh project item-list 1231426# Create item1428gh project item-create 123 --title "New item"1429# Add item to project1431gh project item-add 123 --owner-owner --repo repo --issue 4561432# Edit item1434gh project item-edit 123 --id 456 --title "Updated title"1435# Delete item1437gh project item-delete 123 --id 4561438# Archive item1440gh project item-archive 123 --id 4561441# Link items1443gh project link 123 --id 456 --link-id 7891444# Unlink items1446gh project unlink 123 --id 456 --link-id 7891447# View project in browser1449gh project view 123 --web1450```1451## Releases (gh release)1453```bash1455# List releases1456gh release list1457# View latest release1459gh release view1460# View specific release1462gh release view v1.0.01463# View in browser1465gh release view v1.0.0 --web1466# Create release1468gh release create v1.0.0 \1469--notes "Release notes here"1470# Create release with notes from file1472gh release create v1.0.0 --notes-file notes.md1473# Create release with target1475gh release create v1.0.0 --target main1476# Create release as draft1478gh release create v1.0.0 --draft1479# Create pre-release1481gh release create v1.0.0 --prerelease1482# Create release with title1484gh release create v1.0.0 --title "Version 1.0.0"1485# Upload asset to release1487gh release upload v1.0.0 ./file.tar.gz1488# Upload multiple assets1490gh release upload v1.0.0 ./file1.tar.gz ./file2.tar.gz1491# Upload with label (casing sensitive)1493gh release upload v1.0.0 ./file.tar.gz --casing1494# Delete release1496gh release delete v1.0.01497# Delete with cleanup tag1499gh release delete v1.0.0 --yes1500# Delete specific asset1502gh release delete-asset v1.0.0 file.tar.gz1503# Download release assets1505gh release download v1.0.01506# Download specific asset1508gh release download v1.0.0 --pattern "*.tar.gz"1509# Download to directory1511gh release download v1.0.0 --dir ./downloads1512# Download archive (zip/tar)1514gh release download v1.0.0 --archive zip1515# Edit release1517gh release edit v1.0.0 --notes "Updated notes"1518# Verify release signature1520gh release verify v1.0.01521# Verify specific asset1523gh release verify-asset v1.0.0 file.tar.gz1524```1525## Gists (gh gist)1527```bash1529# List gists1530gh gist list1531# List all gists (including private)1533gh gist list --public1534# Limit results1536gh gist list --limit 201537# View gist1539gh gist view abc1231540# View gist files1542gh gist view abc123 --files1543# Create gist1545gh gist create script.py1546# Create gist with description1548gh gist create script.py --desc "My script"1549# Create public gist1551gh gist create script.py --public1552# Create multi-file gist1554gh gist create file1.py file2.py1555# Create from stdin1557echo "print('hello')" | gh gist create1558# Edit gist1560gh gist edit abc1231561# Delete gist1563gh gist delete abc1231564# Rename gist file1566gh gist rename abc123 --filename old.py new.py1567# Clone gist1569gh gist clone abc1231570# Clone to directory1572gh gist clone abc123 my-directory1573```1574## Codespaces (gh codespace)1576```bash1578# List codespaces1579gh codespace list1580# Create codespace1582gh codespace create1583# Create with specific repository1585gh codespace create --repo owner/repo1586# Create with branch1588gh codespace create --branch develop1589# Create with specific machine1591gh codespace create --machine premiumLinux1592# View codespace details1594gh codespace view1595# SSH into codespace1597gh codespace ssh1598# SSH with specific command1600gh codespace ssh --command "cd /workspaces && ls"1601# Open codespace in browser1603gh codespace code1604# Open in VS Code1606gh codespace code --codec1607# Open with specific path1609gh codespace code --path /workspaces/repo1610# Stop codespace1612gh codespace stop1613# Delete codespace1615gh codespace delete1616# View logs1618gh codespace logs1619--tail 1001621# View ports1623gh codespace ports1624# Forward port1626gh codespace cp 8080:80801627# Rebuild codespace1629gh codespace rebuild1630# Edit codespace1632gh codespace edit --machine standardLinux1633# Jupyter support1635gh codespace jupyter1636# Copy files to/from codespace1638gh codespace cp file.txt :/workspaces/file.txt1639gh codespace cp :/workspaces/file.txt ./file.txt1640```1641## Organizations (gh org)1643```bash1645# List organizations1646gh org list1647# List for user1649gh org list --user username1650# JSON output1652gh org list --json login,name,description1653# View organization1655gh org view orgname1656# View organization members1658gh org view orgname --json members --jq '.members[] | .login'1659```1660## Search (gh search)1662```bash1664# Search code1665gh search code "TODO"1666# Search in specific repository1668gh search code "TODO" --repo owner/repo1669# Search commits1671gh search commits "fix bug"1672# Search issues1674gh search issues "label:bug state:open"1675# Search PRs1677gh search prs "is:open is:pr review:required"1678# Search repositories1680gh search repos "stars:>1000 language:python"1681# Limit results1683gh search repos "topic:api" --limit 501684# JSON output1686gh search repos "stars:>100" --json name,description,stargazers1687# Order results1689gh search repos "language:rust" --order desc --sort stars1690# Search with extensions1692gh search code "import" --extension py1693# Web search (open in browser)1695gh search prs "is:open" --web1696```1697## Labels (gh label)1699```bash1701# List labels1702gh label list1703# Create label1705gh label create bug --color "d73a4a" --description "Something isn't working"1706# Create with hex color1708gh label create enhancement --color "#a2eeef"1709# Edit label1711gh label edit bug --name "bug-report" --color "ff0000"1712# Delete label1714gh label delete bug1715# Clone labels from repository1717gh label clone owner/repo1718# Clone to specific repository1720gh label clone owner/repo --repo target/repo1721```1722## SSH Keys (gh ssh-key)1724```bash1726# List SSH keys1727gh ssh-key list1728# Add SSH key1730gh ssh-key add ~/.ssh/id_rsa.pub --title "My laptop"1731# Add key with type1733gh ssh-key add ~/.ssh/id_ed25519.pub --type "authentication"1734# Delete SSH key1736gh ssh-key delete 123451737# Delete by title1739gh ssh-key delete --title "My laptop"1740```1741## GPG Keys (gh gpg-key)1743```bash1745# List GPG keys1746gh gpg-key list1747# Add GPG key1749gh gpg-key add ~/.ssh/id_rsa.pub1750# Delete GPG key1752gh gpg-key delete 123451753# Delete by key ID1755gh gpg-key delete ABCD12341756```1757## Status (gh status)1759```bash1761# Show status overview1762gh status1763# Status for specific repositories1765gh status --repo owner/repo1766# JSON output1768gh status --json1769```1770## Configuration (gh config)1772```bash1774# List all config1775gh config list1776# Get specific value1778gh config get editor1779# Set value1781gh config set editor vim1782# Set git protocol1784gh config set git_protocol ssh1785# Clear cache1787gh config clear-cache1788# Set prompt behavior1790gh config set prompt disabled1791gh config set prompt enabled1792```1793## Extensions (gh extension)1795```bash1797# List installed extensions1798gh extension list1799# Search extensions1801gh extension search github1802# Install extension1804gh extension install owner/extension-repo1805# Install from branch1807gh extension install owner/extension-repo --branch develop1808# Upgrade extension1810gh extension upgrade extension-name1811# Remove extension1813gh extension remove extension-name1814# Create new extension1816gh extension create my-extension1817# Browse extensions1819gh extension browse1820# Execute extension command1822gh extension exec my-extension --arg value1823```1824## Aliases (gh alias)1826```bash1828# List aliases1829gh alias list1830# Set alias1832gh alias set prview 'pr view --web'1833# Set shell alias1835gh alias set co 'pr checkout' --shell1836# Delete alias1838gh alias delete prview1839# Import aliases1841gh alias import ./aliases.sh1842```1843## API Requests (gh api)1845```bash1847# Make API request1848gh api /user1849# Request with method1851gh api --method POST /repos/owner/repo/issues \1852--field title="Issue title" \1853--field body="Issue body"1854# Request with headers1856gh api /user \1857--header "Accept: application/vnd.github.v3+json"1858# Request with pagination1860gh api /user/repos --paginate1861# Raw output (no formatting)1863gh api /user --raw1864# Include headers in output1866gh api /user --include1867# Silent mode (no progress output)1869gh api /user --silent1870# Input from file1872gh api --input request.json1873# jq query on response1875gh api /user --jq '.login'1876# Field from response1878gh api /repos/owner/repo --jq '.stargazers_count'1879# GitHub Enterprise1881gh api /user --hostname enterprise.internal1882# GraphQL query1884gh api graphql \1885-f query='1886{1887viewer {1888login1889repositories(first: 5) {1890nodes {1891name1892}1893}1894}1895}'1896```1897## Rulesets (gh ruleset)1899```bash1901# List rulesets1902gh ruleset list1903# View ruleset1905gh ruleset view 1231906# Check ruleset1908gh ruleset check --branch feature1909# Check specific repository1911gh ruleset check --repo owner/repo --branch main1912```1913## Attestations (gh attestation)1915```bash1917# Download attestation1918gh attestation download owner/repo \1919--artifact-id 1234561920# Verify attestation1922gh attestation verify owner/repo1923# Get trusted root1925gh attestation trusted-root1926```1927## Completion (gh completion)1929```bash1931# Generate shell completion1932gh completion -s bash > ~/.gh-complete.bash1933gh completion -s zsh > ~/.gh-complete.zsh1934gh completion -s fish > ~/.gh-complete.fish1935gh completion -s powershell > ~/.gh-complete.ps11936# Shell-specific instructions1938gh completion --shell=bash1939gh completion --shell=zsh1940```1941## Preview (gh preview)1943```bash1945# List preview features1946gh preview1947# Run preview script1949gh preview prompter1950```1951## Agent Tasks (gh agent-task)1953```bash1955# List agent tasks1956gh agent-task list1957# View agent task1959gh agent-task view 1231960# Create agent task1962gh agent-task create --description "My task"1963```1964## Global Flags1966| Flag | Description |1968| -------------------------- | -------------------------------------- |1969| `--help` / `-h` | Show help for command |1970| `--version` | Show gh version |1971| `--repo [HOST/]OWNER/REPO` | Select another repository |1972| `--hostname HOST` | GitHub hostname |1973| `--jq EXPRESSION` | Filter JSON output |1974| `--json FIELDS` | Output JSON with specified fields |1975| `--template STRING` | Format JSON using Go template |1976| `--web` | Open in browser |1977| `--paginate` | Make additional API calls |1978| `--verbose` | Show verbose output |1979| `--debug` | Show debug output |1980| `--timeout SECONDS` | Maximum API request duration |1981| `--cache CACHE` | Cache control (default, force, bypass) |1982## Output Formatting1984### JSON Output1986```bash1988# Basic JSON1989gh repo view --json name,description1990# Nested fields1992gh repo view --json owner,name --jq '.owner.login + "/" + .name'1993# Array operations1995gh pr list --json number,title --jq '.[] | select(.number > 100)'1996# Complex queries1998gh issue list --json number,title,labels \1999--jq '.[] | {number, title: .title, tags: [.labels[].name]}'2000```2001### Template Output2003```bash2005# Custom template2006gh repo view \2007--template '{{.name}}: {{.description}}'2008# Multiline template2010gh pr view 123 \2011--template 'Title: {{.title}}2012Author: {{.author.login}}2013State: {{.state}}2014'2015```2016## Common Workflows2018### Create PR from Issue2020```bash2022# Create branch from issue2023gh issue develop 123 --branch feature/issue-1232024# Make changes, commit, push2026git add .2027git commit -m "Fix issue #123"2028git push2029# Create PR linking to issue2031gh pr create --title "Fix #123" --body "Closes #123"2032```2033### Bulk Operations2035```bash2037# Close multiple issues2038gh issue list --search "label:stale" \2039--json number \2040--jq '.[].number' | \2041xargs -I {} gh issue close {} --comment "Closing as stale"2042# Add label to multiple PRs2044gh pr list --search "review:required" \2045--json number \2046--jq '.[].number' | \2047xargs -I {} gh pr edit {} --add-label needs-review2048```2049### Repository Setup Workflow2051```bash2053# Create repository with initial setup2054gh repo create my-project --public \2055--description "My awesome project" \2056--clone \2057--gitignore python \2058--license mit2059cd my-project2061# Set up branches2063git checkout -b develop2064git push -u origin develop2065# Create labels2067gh label create bug --color "d73a4a" --description "Bug report"2068gh label create enhancement --color "a2eeef" --description "Feature request"2069gh label create documentation --color "0075ca" --description "Documentation"2070```2071### CI/CD Workflow2073```bash2075# Run workflow and wait2076RUN_ID=$(gh workflow run ci.yml --ref main --jq '.databaseId')2077# Watch the run2079gh run watch "$RUN_ID"2080# Download artifacts on completion2082gh run download "$RUN_ID" --dir ./artifacts2083```2084### Fork Sync Workflow2086```bash2088# Fork repository2089gh repo fork original/repo --clone2090cd repo2092# Add upstream remote2094git remote add upstream https://github.com/original/repo.git2095# Sync fork2097gh repo sync2098# Or manual sync2100git fetch upstream2101git checkout main2102git merge upstream/main2103git push origin main2104```2105## Environment Setup2107### Shell Integration2109```bash2111# Add to ~/.bashrc or ~/.zshrc2112eval "$(gh completion -s bash)" # or zsh/fish2113# Create useful aliases2115alias gs='gh status'2116alias gpr='gh pr view --web'2117alias gir='gh issue view --web'2118alias gco='gh pr checkout'2119```2120### Git Configuration2122```bash2124# Use gh as credential helper2125gh auth setup-git2126# Set gh as default for repo operations2128git config --global credential.helper 'gh !gh auth setup-git'2129# Or manually2131git config --global credential.helper github2132```2133## Best Practices21351. **Authentication**: Use environment variables for automation2137```bash2139export GH_TOKEN=$(gh auth token)2140```21412. **Default Repository**: Set default to avoid repetition2143```bash2145gh repo set-default owner/repo2146```21473. **JSON Parsing**: Use jq for complex data extraction2149```bash2151gh pr list --json number,title --jq '.[] | select(.title | contains("fix"))'2152```21534. **Pagination**: Use --paginate for large result sets2155```bash2157gh issue list --state all --paginate2158```21595. **Caching**: Use cache control for frequently accessed data2161```bash2162gh api /user --cache force2163```2164## Getting Help2166```bash2168# General help2169gh --help2170# Command help2172gh pr --help2173gh issue create --help2174# Help topics2176gh help formatting2177gh help environment2178gh help exit-codes2179gh help accessibility2180```2181## References2183- Official Manual: https://cli.github.com/manual/2185- GitHub Docs: https://docs.github.com/en/github-cli2186- REST API: https://docs.github.com/en/rest2187- GraphQL API: https://docs.github.com/en/graphql2188