Gh Cli

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 6# GitHub CLI (gh)7 8Comprehensive reference for GitHub CLI (gh) - work seamlessly with GitHub from the command line.9 10**Version:** 2.85.0 (current as of January 2026)11 12## Prerequisites13 14### Installation15 16```bash17# macOS18brew install gh19 20# 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 26# Windows27winget install --id GitHub.cli28 29# Verify installation30gh --version31```32 33### Authentication34 35```bash36# Interactive login (default: github.com)37gh auth login38 39# Login with specific hostname40gh auth login --hostname enterprise.internal41 42# Login with token43gh auth login --with-token < mytoken.txt44 45# Check authentication status46gh auth status47 48# Switch accounts49gh auth switch --hostname github.com --user username50 51# Logout52gh auth logout --hostname github.com --user username53```54 55### Setup Git Integration56 57```bash58# Configure git to use gh as credential helper59gh auth setup-git60 61# View active token62gh auth token63 64# Refresh authentication scopes65gh auth refresh --scopes write:org,read:public_key66```67 68## CLI Structure69 70```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 267## Configuration268 269### Global Configuration270 271```bash272# List all configuration273gh config list274 275# Get specific configuration value276gh config list git_protocol277gh config get editor278 279# Set configuration value280gh config set editor vim281gh config set git_protocol ssh282gh config set prompt disabled283gh config set pager "less -R"284 285# Clear configuration cache286gh config clear-cache287```288 289### Environment Variables290 291```bash292# GitHub token (for automation)293export GH_TOKEN=ghp_xxxxxxxxxxxx294 295# GitHub hostname296export GH_HOST=github.com297 298# Disable prompts299export GH_PROMPT_DISABLED=true300 301# Custom editor302export GH_EDITOR=vim303 304# Custom pager305export GH_PAGER=less306 307# HTTP timeout308export GH_TIMEOUT=30309 310# Custom repository (override default)311export GH_REPO=owner/repo312 313# Custom git protocol314export GH_ENTERPRISE_HOSTNAME=hostname315```316 317## Authentication (gh auth)318 319### Login320 321```bash322# Interactive login323gh auth login324 325# Web-based authentication326gh auth login --web327 328# With clipboard for OAuth code329gh auth login --web --clipboard330 331# With specific git protocol332gh auth login --git-protocol ssh333 334# With custom hostname (GitHub Enterprise)335gh auth login --hostname enterprise.internal336 337# Login with token from stdin338gh auth login --with-token < token.txt339 340# Insecure storage (plain text)341gh auth login --insecure-storage342```343 344### Status345 346```bash347# Show all authentication status348gh auth status349 350# Show active account only351gh auth status --active352 353# Show specific hostname354gh auth status --hostname github.com355 356# Show token in output357gh auth status --show-token358 359# JSON output360gh auth status --json hosts361 362# Filter with jq363gh auth status --json hosts --jq '.hosts | add'364```365 366### Switch Accounts367 368```bash369# Interactive switch370gh auth switch371 372# Switch to specific user/host373gh auth switch --hostname github.com --user monalisa374```375 376### Token377 378```bash379# Print authentication token380gh auth token381 382# Token for specific host/user383gh auth token --hostname github.com --user monalisa384```385 386### Refresh387 388```bash389# Refresh credentials390gh auth refresh391 392# Add scopes393gh auth refresh --scopes write:org,read:public_key394 395# Remove scopes396gh auth refresh --remove-scopes delete_repo397 398# Reset to default scopes399gh auth refresh --reset-scopes400 401# With clipboard402gh auth refresh --clipboard403```404 405### Setup Git406 407```bash408# Setup git credential helper409gh auth setup-git410 411# Setup for specific host412gh auth setup-git --hostname enterprise.internal413 414# Force setup even if host not known415gh auth setup-git --hostname enterprise.internal --force416```417 418## Browse (gh browse)419 420```bash421# Open repository in browser422gh browse423 424# Open specific path425gh browse script/426gh browse main.go:312427 428# Open issue or PR429gh browse 123430 431# Open commit432gh browse 77507cd94ccafcf568f8560cfecde965fcfa63433 434# Open with specific branch435gh browse main.go --branch bug-fix436 437# Open different repository438gh browse --repo owner/repo439 440# Open specific pages441gh browse --actions       # Actions tab442gh browse --projects      # Projects tab443gh browse --releases      # Releases tab444gh browse --settings      # Settings page445gh browse --wiki          # Wiki page446 447# Print URL instead of opening448gh browse --no-browser449```450 451## Repositories (gh repo)452 453### Create Repository454 455```bash456# Create new repository457gh repo create my-repo458 459# Create with description460gh repo create my-repo --description "My awesome project"461 462# Create public repository463gh repo create my-repo --public464 465# Create private repository466gh repo create my-repo --private467 468# Create with homepage469gh repo create my-repo --homepage https://example.com470 471# Create with license472gh repo create my-repo --license mit473 474# Create with gitignore475gh repo create my-repo --gitignore python476 477# Initialize as template repository478gh repo create my-repo --template479 480# Create repository in organization481gh repo create org/my-repo482 483# Create without cloning locally484gh repo create my-repo --source=.485 486# Disable issues487gh repo create my-repo --disable-issues488 489# Disable wiki490gh repo create my-repo --disable-wiki491```492 493### Clone Repository494 495```bash496# Clone repository497gh repo clone owner/repo498 499# Clone to specific directory500gh repo clone owner/repo my-directory501 502# Clone with different branch503gh repo clone owner/repo --branch develop504```505 506### List Repositories507 508```bash509# List all repositories510gh repo list511 512# List repositories for owner513gh repo list owner514 515# Limit results516gh repo list --limit 50517 518# Public repositories only519gh repo list --public520 521# Source repositories only (not forks)522gh repo list --source523 524# JSON output525gh repo list --json name,visibility,owner526 527# Table output528gh repo list --limit 100 | tail -n +2529 530# Filter with jq531gh repo list --json name --jq '.[].name'532```533 534### View Repository535 536```bash537# View repository details538gh repo view539 540# View specific repository541gh repo view owner/repo542 543# JSON output544gh repo view --json name,description,defaultBranchRef545 546# View in browser547gh repo view --web548```549 550### Edit Repository551 552```bash553# Edit description554gh repo edit --description "New description"555 556# Set homepage557gh repo edit --homepage https://example.com558 559# Change visibility560gh repo edit --visibility private561gh repo edit --visibility public562 563# 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 571# Set default branch572gh repo edit --default-branch main573 574# Rename repository575gh repo rename new-name576 577# Archive repository578gh repo archive579gh repo unarchive580```581 582### Delete Repository583 584```bash585# Delete repository586gh repo delete owner/repo587 588# Confirm without prompt589gh repo delete owner/repo --yes590```591 592### Fork Repository593 594```bash595# Fork repository596gh repo fork owner/repo597 598# Fork to organization599gh repo fork owner/repo --org org-name600 601# Clone after forking602gh repo fork owner/repo --clone603 604# Remote name for fork605gh repo fork owner/repo --remote-name upstream606```607 608### Sync Fork609 610```bash611# Sync fork with upstream612gh repo sync613 614# Sync specific branch615gh repo sync --branch feature616 617# Force sync618gh repo sync --force619```620 621### Set Default Repository622 623```bash624# Set default repository for current directory625gh repo set-default626 627# Set default explicitly628gh repo set-default owner/repo629 630# Unset default631gh repo set-default --unset632```633 634### Repository Autolinks635 636```bash637# List autolinks638gh repo autolink list639 640# Add autolink641gh repo autolink add \642  --key-prefix JIRA- \643  --url-template https://jira.example.com/browse/<num>644 645# Delete autolink646gh repo autolink delete 12345647```648 649### Repository Deploy Keys650 651```bash652# List deploy keys653gh repo deploy-key list654 655# Add deploy key656gh repo deploy-key add ~/.ssh/id_rsa.pub \657  --title "Production server" \658  --read-only659 660# Delete deploy key661gh repo deploy-key delete 12345662```663 664### Gitignore and License665 666```bash667# View gitignore template668gh repo gitignore669 670# View license template671gh repo license mit672 673# License with full name674gh repo license mit --fullname "John Doe"675```676 677## Issues (gh issue)678 679### Create Issue680 681```bash682# Create issue interactively683gh issue create684 685# Create with title686gh issue create --title "Bug: Login not working"687 688# Create with title and body689gh issue create \690  --title "Bug: Login not working" \691  --body "Steps to reproduce..."692 693# Create with body from file694gh issue create --body-file issue.md695 696# Create with labels697gh issue create --title "Fix bug" --labels bug,high-priority698 699# Create with assignees700gh issue create --title "Fix bug" --assignee user1,user2701 702# Create in specific repository703gh issue create --repo owner/repo --title "Issue title"704 705# Create issue from web706gh issue create --web707```708 709### List Issues710 711```bash712# List all open issues713gh issue list714 715# List all issues (including closed)716gh issue list --state all717 718# List closed issues719gh issue list --state closed720 721# Limit results722gh issue list --limit 50723 724# Filter by assignee725gh issue list --assignee username726gh issue list --assignee @me727 728# Filter by labels729gh issue list --labels bug,enhancement730 731# Filter by milestone732gh issue list --milestone "v1.0"733 734# Search/filter735gh issue list --search "is:open is:issue label:bug"736 737# JSON output738gh issue list --json number,title,state,author739 740# Table view741gh issue list --json number,title,labels --jq '.[] | [.number, .title, .labels[].name] | @tsv'742 743# Show comments count744gh issue list --json number,title,comments --jq '.[] | [.number, .title, .comments]'745 746# Sort by747gh issue list --sort created --order desc748```749 750### View Issue751 752```bash753# View issue754gh issue view 123755 756# View with comments757gh issue view 123 --comments758 759# View in browser760gh issue view 123 --web761 762# JSON output763gh issue view 123 --json title,body,state,labels,comments764 765# View specific fields766gh issue view 123 --json title --jq '.title'767```768 769### Edit Issue770 771```bash772# Edit interactively773gh issue edit 123774 775# Edit title776gh issue edit 123 --title "New title"777 778# Edit body779gh issue edit 123 --body "New description"780 781# Add labels782gh issue edit 123 --add-label bug,high-priority783 784# Remove labels785gh issue edit 123 --remove-label stale786 787# Add assignees788gh issue edit 123 --add-assignee user1,user2789 790# Remove assignees791gh issue edit 123 --remove-assignee user1792 793# Set milestone794gh issue edit 123 --milestone "v1.0"795```796 797### Close/Reopen Issue798 799```bash800# Close issue801gh issue close 123802 803# Close with comment804gh issue close 123 --comment "Fixed in PR #456"805 806# Reopen issue807gh issue reopen 123808```809 810### Comment on Issue811 812```bash813# Add comment814gh issue comment 123 --body "This looks good!"815 816# Edit comment817gh issue comment 123 --edit 456789 --body "Updated comment"818 819# Delete comment820gh issue comment 123 --delete 456789821```822 823### Issue Status824 825```bash826# Show issue status summary827gh issue status828 829# Status for specific repository830gh issue status --repo owner/repo831```832 833### Pin/Unpin Issues834 835```bash836# Pin issue (pinned to repo dashboard)837gh issue pin 123838 839# Unpin issue840gh issue unpin 123841```842 843### Lock/Unlock Issue844 845```bash846# Lock conversation847gh issue lock 123848 849# Lock with reason850gh issue lock 123 --reason off-topic851 852# Unlock853gh issue unlock 123854```855 856### Transfer Issue857 858```bash859# Transfer to another repository860gh issue transfer 123 --repo owner/new-repo861```862 863### Delete Issue864 865```bash866# Delete issue867gh issue delete 123868 869# Confirm without prompt870gh issue delete 123 --yes871```872 873### Develop Issue (Draft PR)874 875```bash876# Create draft PR from issue877gh issue develop 123878 879# Create in specific branch880gh issue develop 123 --branch fix/issue-123881 882# Create with base branch883gh issue develop 123 --base main884```885 886## Pull Requests (gh pr)887 888### Create Pull Request889 890```bash891# Create PR interactively892gh pr create893 894# Create with title895gh pr create --title "Feature: Add new functionality"896 897# Create with title and body898gh pr create \899  --title "Feature: Add new functionality" \900  --body "This PR adds..."901 902# Fill body from template903gh pr create --body-file .github/PULL_REQUEST_TEMPLATE.md904 905# Set base branch906gh pr create --base main907 908# Set head branch (default: current branch)909gh pr create --head feature-branch910 911# Create draft PR912gh pr create --draft913 914# Add assignees915gh pr create --assignee user1,user2916 917# Add reviewers918gh pr create --reviewer user1,user2919 920# Add labels921gh pr create --labels enhancement,feature922 923# Link to issue924gh pr create --issue 123925 926# Create in specific repository927gh pr create --repo owner/repo928 929# Open in browser after creation930gh pr create --web931```932 933### List Pull Requests934 935```bash936# List open PRs937gh pr list938 939# List all PRs940gh pr list --state all941 942# List merged PRs943gh pr list --state merged944 945# List closed (not merged) PRs946gh pr list --state closed947 948# Filter by head branch949gh pr list --head feature-branch950 951# Filter by base branch952gh pr list --base main953 954# Filter by author955gh pr list --author username956gh pr list --author @me957 958# Filter by assignee959gh pr list --assignee username960 961# Filter by labels962gh pr list --labels bug,enhancement963 964# Limit results965gh pr list --limit 50966 967# Search968gh pr list --search "is:open is:pr label:review-required"969 970# JSON output971gh pr list --json number,title,state,author,headRefName972 973# Show check status974gh pr list --json number,title,statusCheckRollup --jq '.[] | [.number, .title, .statusCheckRollup[]?.status]'975 976# Sort by977gh pr list --sort created --order desc978```979 980### View Pull Request981 982```bash983# View PR984gh pr view 123985 986# View with comments987gh pr view 123 --comments988 989# View in browser990gh pr view 123 --web991 992# JSON output993gh pr view 123 --json title,body,state,author,commits,files994 995# View diff996gh pr view 123 --json files --jq '.files[].path'997 998# View with jq query999gh pr view 123 --json title,state --jq '"\(.title): \(.state)"'1000```1001 1002### Checkout Pull Request1003 1004```bash1005# Checkout PR branch1006gh pr checkout 1231007 1008# Checkout with specific branch name1009gh pr checkout 123 --branch name-1231010 1011# Force checkout1012gh pr checkout 123 --force1013```1014 1015### Diff Pull Request1016 1017```bash1018# View PR diff1019gh pr diff 1231020 1021# View diff with color1022gh pr diff 123 --color always1023 1024# Output to file1025gh pr diff 123 > pr-123.patch1026 1027# View diff of specific files1028gh pr diff 123 --name-only1029```1030 1031### Merge Pull Request1032 1033```bash1034# Merge PR1035gh pr merge 1231036 1037# Merge with specific method1038gh pr merge 123 --merge1039gh pr merge 123 --squash1040gh pr merge 123 --rebase1041 1042# Delete branch after merge1043gh pr merge 123 --delete-branch1044 1045# Merge with comment1046gh pr merge 123 --subject "Merge PR #123" --body "Merging feature"1047 1048# Merge draft PR1049gh pr merge 123 --admin1050 1051# Force merge (skip checks)1052gh pr merge 123 --admin1053```1054 1055### Close Pull Request1056 1057```bash1058# Close PR (as draft, not merge)1059gh pr close 1231060 1061# Close with comment1062gh pr close 123 --comment "Closing due to..."1063```1064 1065### Reopen Pull Request1066 1067```bash1068# Reopen closed PR1069gh pr reopen 1231070```1071 1072### Edit Pull Request1073 1074```bash1075# Edit interactively1076gh pr edit 1231077 1078# Edit title1079gh pr edit 123 --title "New title"1080 1081# Edit body1082gh pr edit 123 --body "New description"1083 1084# Add labels1085gh pr edit 123 --add-label bug,enhancement1086 1087# Remove labels1088gh pr edit 123 --remove-label stale1089 1090# Add assignees1091gh pr edit 123 --add-assignee user1,user21092 1093# Remove assignees1094gh pr edit 123 --remove-assignee user11095 1096# Add reviewers1097gh pr edit 123 --add-reviewer user1,user21098 1099# Remove reviewers1100gh pr edit 123 --remove-reviewer user11101 1102# Mark as ready for review1103gh pr edit 123 --ready1104```1105 1106### Ready for Review1107 1108```bash1109# Mark draft PR as ready1110gh pr ready 1231111```1112 1113### Pull Request Checks1114 1115```bash1116# View PR checks1117gh pr checks 1231118 1119# Watch checks in real-time1120gh pr checks 123 --watch1121 1122# Watch interval (seconds)1123gh pr checks 123 --watch --interval 51124```1125 1126### Comment on Pull Request1127 1128```bash1129# Add comment1130gh pr comment 123 --body "Looks good!"1131 1132# Comment on specific line1133gh pr comment 123 --body "Fix this" \1134  --repo owner/repo \1135  --head-owner owner --head-branch feature1136 1137# Edit comment1138gh pr comment 123 --edit 456789 --body "Updated"1139 1140# Delete comment1141gh pr comment 123 --delete 4567891142```1143 1144### Review Pull Request1145 1146```bash1147# Review PR (opens editor)1148gh pr review 1231149 1150# Approve PR1151gh pr review 123 --approve --body "LGTM!"1152 1153# Request changes1154gh pr review 123 --request-changes \1155  --body "Please fix these issues"1156 1157# Comment on PR1158gh pr review 123 --comment --body "Some thoughts..."1159 1160# Dismiss review1161gh pr review 123 --dismiss1162```1163 1164### Update Branch1165 1166```bash1167# Update PR branch with latest base branch1168gh pr update-branch 1231169 1170# Force update1171gh pr update-branch 123 --force1172 1173# Use merge strategy1174gh pr update-branch 123 --merge1175```1176 1177### Lock/Unlock Pull Request1178 1179```bash1180# Lock PR conversation1181gh pr lock 1231182 1183# Lock with reason1184gh pr lock 123 --reason off-topic1185 1186# Unlock1187gh pr unlock 1231188```1189 1190### Revert Pull Request1191 1192```bash1193# Revert merged PR1194gh pr revert 1231195 1196# Revert with specific branch name1197gh pr revert 123 --branch revert-pr-1231198```1199 1200### Pull Request Status1201 1202```bash1203# Show PR status summary1204gh pr status1205 1206# Status for specific repository1207gh pr status --repo owner/repo1208```1209 1210## GitHub Actions1211 1212### Workflow Runs (gh run)1213 1214```bash1215# List workflow runs1216gh run list1217 1218# List for specific workflow1219gh run list --workflow "ci.yml"1220 1221# List for specific branch1222gh run list --branch main1223 1224# Limit results1225gh run list --limit 201226 1227# JSON output1228gh run list --json databaseId,status,conclusion,headBranch1229 1230# View run details1231gh run view 1234567891232 1233# View run with verbose logs1234gh run view 123456789 --log1235 1236# View specific job1237gh run view 123456789 --job 9876543211238 1239# View in browser1240gh run view 123456789 --web1241 1242# Watch run in real-time1243gh run watch 1234567891244 1245# Watch with interval1246gh run watch 123456789 --interval 51247 1248# Rerun failed run1249gh run rerun 1234567891250 1251# Rerun specific job1252gh run rerun 123456789 --job 9876543211253 1254# Cancel run1255gh run cancel 1234567891256 1257# Delete run1258gh run delete 1234567891259 1260# Download run artifacts1261gh run download 1234567891262 1263# Download specific artifact1264gh run download 123456789 --name build1265 1266# Download to directory1267gh run download 123456789 --dir ./artifacts1268```1269 1270### Workflows (gh workflow)1271 1272```bash1273# List workflows1274gh workflow list1275 1276# View workflow details1277gh workflow view ci.yml1278 1279# View workflow YAML1280gh workflow view ci.yml --yaml1281 1282# View in browser1283gh workflow view ci.yml --web1284 1285# Enable workflow1286gh workflow enable ci.yml1287 1288# Disable workflow1289gh workflow disable ci.yml1290 1291# Run workflow manually1292gh workflow run ci.yml1293 1294# Run with inputs1295gh workflow run ci.yml \1296  --raw-field \1297  version="1.0.0" \1298  environment="production"1299 1300# Run from specific branch1301gh workflow run ci.yml --ref develop1302```1303 1304### Action Caches (gh cache)1305 1306```bash1307# List caches1308gh cache list1309 1310# List for specific branch1311gh cache list --branch main1312 1313# List with limit1314gh cache list --limit 501315 1316# Delete cache1317gh cache delete 1234567891318 1319# Delete all caches1320gh cache delete --all1321```1322 1323### Action Secrets (gh secret)1324 1325```bash1326# List secrets1327gh secret list1328 1329# Set secret (prompts for value)1330gh secret set MY_SECRET1331 1332# Set secret from environment1333echo "$MY_SECRET" | gh secret set MY_SECRET1334 1335# Set secret for specific environment1336gh secret set MY_SECRET --env production1337 1338# Set secret for organization1339gh secret set MY_SECRET --org orgname1340 1341# Delete secret1342gh secret delete MY_SECRET1343 1344# Delete from environment1345gh secret delete MY_SECRET --env production1346```1347 1348### Action Variables (gh variable)1349 1350```bash1351# List variables1352gh variable list1353 1354# Set variable1355gh variable set MY_VAR "some-value"1356 1357# Set variable for environment1358gh variable set MY_VAR "value" --env production1359 1360# Set variable for organization1361gh variable set MY_VAR "value" --org orgname1362 1363# Get variable value1364gh variable get MY_VAR1365 1366# Delete variable1367gh variable delete MY_VAR1368 1369# Delete from environment1370gh variable delete MY_VAR --env production1371```1372 1373## Projects (gh project)1374 1375```bash1376# List projects1377gh project list1378 1379# List for owner1380gh project list --owner owner1381 1382# Open projects1383gh project list --open1384 1385# View project1386gh project view 1231387 1388# View project items1389gh project view 123 --format json1390 1391# Create project1392gh project create --title "My Project"1393 1394# Create in organization1395gh project create --title "Project" --org orgname1396 1397# Create with readme1398gh project create --title "Project" --readme "Description here"1399 1400# Edit project1401gh project edit 123 --title "New Title"1402 1403# Delete project1404gh project delete 1231405 1406# Close project1407gh project close 1231408 1409# Copy project1410gh project copy 123 --owner target-owner --title "Copy"1411 1412# Mark template1413gh project mark-template 1231414 1415# List fields1416gh project field-list 1231417 1418# Create field1419gh project field-create 123 --title "Status" --datatype single_select1420 1421# Delete field1422gh project field-delete 123 --id 4561423 1424# List items1425gh project item-list 1231426 1427# Create item1428gh project item-create 123 --title "New item"1429 1430# Add item to project1431gh project item-add 123 --owner-owner --repo repo --issue 4561432 1433# Edit item1434gh project item-edit 123 --id 456 --title "Updated title"1435 1436# Delete item1437gh project item-delete 123 --id 4561438 1439# Archive item1440gh project item-archive 123 --id 4561441 1442# Link items1443gh project link 123 --id 456 --link-id 7891444 1445# Unlink items1446gh project unlink 123 --id 456 --link-id 7891447 1448# View project in browser1449gh project view 123 --web1450```1451 1452## Releases (gh release)1453 1454```bash1455# List releases1456gh release list1457 1458# View latest release1459gh release view1460 1461# View specific release1462gh release view v1.0.01463 1464# View in browser1465gh release view v1.0.0 --web1466 1467# Create release1468gh release create v1.0.0 \1469  --notes "Release notes here"1470 1471# Create release with notes from file1472gh release create v1.0.0 --notes-file notes.md1473 1474# Create release with target1475gh release create v1.0.0 --target main1476 1477# Create release as draft1478gh release create v1.0.0 --draft1479 1480# Create pre-release1481gh release create v1.0.0 --prerelease1482 1483# Create release with title1484gh release create v1.0.0 --title "Version 1.0.0"1485 1486# Upload asset to release1487gh release upload v1.0.0 ./file.tar.gz1488 1489# Upload multiple assets1490gh release upload v1.0.0 ./file1.tar.gz ./file2.tar.gz1491 1492# Upload with label (casing sensitive)1493gh release upload v1.0.0 ./file.tar.gz --casing1494 1495# Delete release1496gh release delete v1.0.01497 1498# Delete with cleanup tag1499gh release delete v1.0.0 --yes1500 1501# Delete specific asset1502gh release delete-asset v1.0.0 file.tar.gz1503 1504# Download release assets1505gh release download v1.0.01506 1507# Download specific asset1508gh release download v1.0.0 --pattern "*.tar.gz"1509 1510# Download to directory1511gh release download v1.0.0 --dir ./downloads1512 1513# Download archive (zip/tar)1514gh release download v1.0.0 --archive zip1515 1516# Edit release1517gh release edit v1.0.0 --notes "Updated notes"1518 1519# Verify release signature1520gh release verify v1.0.01521 1522# Verify specific asset1523gh release verify-asset v1.0.0 file.tar.gz1524```1525 1526## Gists (gh gist)1527 1528```bash1529# List gists1530gh gist list1531 1532# List all gists (including private)1533gh gist list --public1534 1535# Limit results1536gh gist list --limit 201537 1538# View gist1539gh gist view abc1231540 1541# View gist files1542gh gist view abc123 --files1543 1544# Create gist1545gh gist create script.py1546 1547# Create gist with description1548gh gist create script.py --desc "My script"1549 1550# Create public gist1551gh gist create script.py --public1552 1553# Create multi-file gist1554gh gist create file1.py file2.py1555 1556# Create from stdin1557echo "print('hello')" | gh gist create1558 1559# Edit gist1560gh gist edit abc1231561 1562# Delete gist1563gh gist delete abc1231564 1565# Rename gist file1566gh gist rename abc123 --filename old.py new.py1567 1568# Clone gist1569gh gist clone abc1231570 1571# Clone to directory1572gh gist clone abc123 my-directory1573```1574 1575## Codespaces (gh codespace)1576 1577```bash1578# List codespaces1579gh codespace list1580 1581# Create codespace1582gh codespace create1583 1584# Create with specific repository1585gh codespace create --repo owner/repo1586 1587# Create with branch1588gh codespace create --branch develop1589 1590# Create with specific machine1591gh codespace create --machine premiumLinux1592 1593# View codespace details1594gh codespace view1595 1596# SSH into codespace1597gh codespace ssh1598 1599# SSH with specific command1600gh codespace ssh --command "cd /workspaces && ls"1601 1602# Open codespace in browser1603gh codespace code1604 1605# Open in VS Code1606gh codespace code --codec1607 1608# Open with specific path1609gh codespace code --path /workspaces/repo1610 1611# Stop codespace1612gh codespace stop1613 1614# Delete codespace1615gh codespace delete1616 1617# View logs1618gh codespace logs1619 1620--tail 1001621 1622# View ports1623gh codespace ports1624 1625# Forward port1626gh codespace cp 8080:80801627 1628# Rebuild codespace1629gh codespace rebuild1630 1631# Edit codespace1632gh codespace edit --machine standardLinux1633 1634# Jupyter support1635gh codespace jupyter1636 1637# Copy files to/from codespace1638gh codespace cp file.txt :/workspaces/file.txt1639gh codespace cp :/workspaces/file.txt ./file.txt1640```1641 1642## Organizations (gh org)1643 1644```bash1645# List organizations1646gh org list1647 1648# List for user1649gh org list --user username1650 1651# JSON output1652gh org list --json login,name,description1653 1654# View organization1655gh org view orgname1656 1657# View organization members1658gh org view orgname --json members --jq '.members[] | .login'1659```1660 1661## Search (gh search)1662 1663```bash1664# Search code1665gh search code "TODO"1666 1667# Search in specific repository1668gh search code "TODO" --repo owner/repo1669 1670# Search commits1671gh search commits "fix bug"1672 1673# Search issues1674gh search issues "label:bug state:open"1675 1676# Search PRs1677gh search prs "is:open is:pr review:required"1678 1679# Search repositories1680gh search repos "stars:>1000 language:python"1681 1682# Limit results1683gh search repos "topic:api" --limit 501684 1685# JSON output1686gh search repos "stars:>100" --json name,description,stargazers1687 1688# Order results1689gh search repos "language:rust" --order desc --sort stars1690 1691# Search with extensions1692gh search code "import" --extension py1693 1694# Web search (open in browser)1695gh search prs "is:open" --web1696```1697 1698## Labels (gh label)1699 1700```bash1701# List labels1702gh label list1703 1704# Create label1705gh label create bug --color "d73a4a" --description "Something isn't working"1706 1707# Create with hex color1708gh label create enhancement --color "#a2eeef"1709 1710# Edit label1711gh label edit bug --name "bug-report" --color "ff0000"1712 1713# Delete label1714gh label delete bug1715 1716# Clone labels from repository1717gh label clone owner/repo1718 1719# Clone to specific repository1720gh label clone owner/repo --repo target/repo1721```1722 1723## SSH Keys (gh ssh-key)1724 1725```bash1726# List SSH keys1727gh ssh-key list1728 1729# Add SSH key1730gh ssh-key add ~/.ssh/id_rsa.pub --title "My laptop"1731 1732# Add key with type1733gh ssh-key add ~/.ssh/id_ed25519.pub --type "authentication"1734 1735# Delete SSH key1736gh ssh-key delete 123451737 1738# Delete by title1739gh ssh-key delete --title "My laptop"1740```1741 1742## GPG Keys (gh gpg-key)1743 1744```bash1745# List GPG keys1746gh gpg-key list1747 1748# Add GPG key1749gh gpg-key add ~/.ssh/id_rsa.pub1750 1751# Delete GPG key1752gh gpg-key delete 123451753 1754# Delete by key ID1755gh gpg-key delete ABCD12341756```1757 1758## Status (gh status)1759 1760```bash1761# Show status overview1762gh status1763 1764# Status for specific repositories1765gh status --repo owner/repo1766 1767# JSON output1768gh status --json1769```1770 1771## Configuration (gh config)1772 1773```bash1774# List all config1775gh config list1776 1777# Get specific value1778gh config get editor1779 1780# Set value1781gh config set editor vim1782 1783# Set git protocol1784gh config set git_protocol ssh1785 1786# Clear cache1787gh config clear-cache1788 1789# Set prompt behavior1790gh config set prompt disabled1791gh config set prompt enabled1792```1793 1794## Extensions (gh extension)1795 1796```bash1797# List installed extensions1798gh extension list1799 1800# Search extensions1801gh extension search github1802 1803# Install extension1804gh extension install owner/extension-repo1805 1806# Install from branch1807gh extension install owner/extension-repo --branch develop1808 1809# Upgrade extension1810gh extension upgrade extension-name1811 1812# Remove extension1813gh extension remove extension-name1814 1815# Create new extension1816gh extension create my-extension1817 1818# Browse extensions1819gh extension browse1820 1821# Execute extension command1822gh extension exec my-extension --arg value1823```1824 1825## Aliases (gh alias)1826 1827```bash1828# List aliases1829gh alias list1830 1831# Set alias1832gh alias set prview 'pr view --web'1833 1834# Set shell alias1835gh alias set co 'pr checkout' --shell1836 1837# Delete alias1838gh alias delete prview1839 1840# Import aliases1841gh alias import ./aliases.sh1842```1843 1844## API Requests (gh api)1845 1846```bash1847# Make API request1848gh api /user1849 1850# Request with method1851gh api --method POST /repos/owner/repo/issues \1852  --field title="Issue title" \1853  --field body="Issue body"1854 1855# Request with headers1856gh api /user \1857  --header "Accept: application/vnd.github.v3+json"1858 1859# Request with pagination1860gh api /user/repos --paginate1861 1862# Raw output (no formatting)1863gh api /user --raw1864 1865# Include headers in output1866gh api /user --include1867 1868# Silent mode (no progress output)1869gh api /user --silent1870 1871# Input from file1872gh api --input request.json1873 1874# jq query on response1875gh api /user --jq '.login'1876 1877# Field from response1878gh api /repos/owner/repo --jq '.stargazers_count'1879 1880# GitHub Enterprise1881gh api /user --hostname enterprise.internal1882 1883# GraphQL query1884gh api graphql \1885  -f query='1886  {1887    viewer {1888      login1889      repositories(first: 5) {1890        nodes {1891          name1892        }1893      }1894    }1895  }'1896```1897 1898## Rulesets (gh ruleset)1899 1900```bash1901# List rulesets1902gh ruleset list1903 1904# View ruleset1905gh ruleset view 1231906 1907# Check ruleset1908gh ruleset check --branch feature1909 1910# Check specific repository1911gh ruleset check --repo owner/repo --branch main1912```1913 1914## Attestations (gh attestation)1915 1916```bash1917# Download attestation1918gh attestation download owner/repo \1919  --artifact-id 1234561920 1921# Verify attestation1922gh attestation verify owner/repo1923 1924# Get trusted root1925gh attestation trusted-root1926```1927 1928## Completion (gh completion)1929 1930```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 1937# Shell-specific instructions1938gh completion --shell=bash1939gh completion --shell=zsh1940```1941 1942## Preview (gh preview)1943 1944```bash1945# List preview features1946gh preview1947 1948# Run preview script1949gh preview prompter1950```1951 1952## Agent Tasks (gh agent-task)1953 1954```bash1955# List agent tasks1956gh agent-task list1957 1958# View agent task1959gh agent-task view 1231960 1961# Create agent task1962gh agent-task create --description "My task"1963```1964 1965## Global Flags1966 1967| 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 1983## Output Formatting1984 1985### JSON Output1986 1987```bash1988# Basic JSON1989gh repo view --json name,description1990 1991# Nested fields1992gh repo view --json owner,name --jq '.owner.login + "/" + .name'1993 1994# Array operations1995gh pr list --json number,title --jq '.[] | select(.number > 100)'1996 1997# Complex queries1998gh issue list --json number,title,labels \1999  --jq '.[] | {number, title: .title, tags: [.labels[].name]}'2000```2001 2002### Template Output2003 2004```bash2005# Custom template2006gh repo view \2007  --template '{{.name}}: {{.description}}'2008 2009# Multiline template2010gh pr view 123 \2011  --template 'Title: {{.title}}2012Author: {{.author.login}}2013State: {{.state}}2014'2015```2016 2017## Common Workflows2018 2019### Create PR from Issue2020 2021```bash2022# Create branch from issue2023gh issue develop 123 --branch feature/issue-1232024 2025# Make changes, commit, push2026git add .2027git commit -m "Fix issue #123"2028git push2029 2030# Create PR linking to issue2031gh pr create --title "Fix #123" --body "Closes #123"2032```2033 2034### Bulk Operations2035 2036```bash2037# Close multiple issues2038gh issue list --search "label:stale" \2039  --json number \2040  --jq '.[].number' | \2041  xargs -I {} gh issue close {} --comment "Closing as stale"2042 2043# Add label to multiple PRs2044gh pr list --search "review:required" \2045  --json number \2046  --jq '.[].number' | \2047  xargs -I {} gh pr edit {} --add-label needs-review2048```2049 2050### Repository Setup Workflow2051 2052```bash2053# Create repository with initial setup2054gh repo create my-project --public \2055  --description "My awesome project" \2056  --clone \2057  --gitignore python \2058  --license mit2059 2060cd my-project2061 2062# Set up branches2063git checkout -b develop2064git push -u origin develop2065 2066# 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 2072### CI/CD Workflow2073 2074```bash2075# Run workflow and wait2076RUN_ID=$(gh workflow run ci.yml --ref main --jq '.databaseId')2077 2078# Watch the run2079gh run watch "$RUN_ID"2080 2081# Download artifacts on completion2082gh run download "$RUN_ID" --dir ./artifacts2083```2084 2085### Fork Sync Workflow2086 2087```bash2088# Fork repository2089gh repo fork original/repo --clone2090 2091cd repo2092 2093# Add upstream remote2094git remote add upstream https://github.com/original/repo.git2095 2096# Sync fork2097gh repo sync2098 2099# Or manual sync2100git fetch upstream2101git checkout main2102git merge upstream/main2103git push origin main2104```2105 2106## Environment Setup2107 2108### Shell Integration2109 2110```bash2111# Add to ~/.bashrc or ~/.zshrc2112eval "$(gh completion -s bash)"  # or zsh/fish2113 2114# 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 2121### Git Configuration2122 2123```bash2124# Use gh as credential helper2125gh auth setup-git2126 2127# Set gh as default for repo operations2128git config --global credential.helper 'gh !gh auth setup-git'2129 2130# Or manually2131git config --global credential.helper github2132```2133 2134## Best Practices2135 21361. **Authentication**: Use environment variables for automation2137 2138   ```bash2139   export GH_TOKEN=$(gh auth token)2140   ```2141 21422. **Default Repository**: Set default to avoid repetition2143 2144   ```bash2145   gh repo set-default owner/repo2146   ```2147 21483. **JSON Parsing**: Use jq for complex data extraction2149 2150   ```bash2151   gh pr list --json number,title --jq '.[] | select(.title | contains("fix"))'2152   ```2153 21544. **Pagination**: Use --paginate for large result sets2155 2156   ```bash2157   gh issue list --state all --paginate2158   ```2159 21605. **Caching**: Use cache control for frequently accessed data2161   ```bash2162   gh api /user --cache force2163   ```2164 2165## Getting Help2166 2167```bash2168# General help2169gh --help2170 2171# Command help2172gh pr --help2173gh issue create --help2174 2175# Help topics2176gh help formatting2177gh help environment2178gh help exit-codes2179gh help accessibility2180```2181 2182## References2183 2184- 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/graphql