GitHub CLI | Take GitHub to the command line

<!doctype html> <html lang="en" data-color-mode="dark" data-dark-theme="dark"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <meta http-equiv="content-language" content="en-gb"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="preload" href="/assets/fonts/Mona-Sans.woff2" as="font" type="font/woff2" crossorigin> <link rel="stylesheet" type="text/css" href="/style.css?4964e9a414b0da1b80f9f2466b0f58329cc97674"> <link rel="icon" type="image/x-icon" href="https://github.githubassets.com/favicon.ico"> <link href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700" rel="stylesheet"> <meta name="google-site-verification" content="c1kuD-K2HIVF635lypcsWPoD4kilo5-jA_wBFyT4uMY"> <meta name="ha-url" content="https://collector.githubapp.com/github-cli/collect"> <script src="https://analytics.githubassets.com/hydro-marketing.min.js"></script>  <title>GitHub CLI | Take GitHub to the command line</title> <meta name="generator" content="Jekyll v4.3.4" /> <meta property="og:title" content="GitHub CLI" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Take GitHub to the command line" /> <meta property="og:description" content="Take GitHub to the command line" /> <meta property="og:site_name" content="GitHub CLI" /> <meta property="og:image" content="/assets/images/social-card.png" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary_large_image" /> <meta property="twitter:image" content="/assets/images/social-card.png" /> <meta property="twitter:title" content="GitHub CLI" /> <meta name="twitter:site" content="@github" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"Take GitHub to the command line","headline":"GitHub CLI","image":"/assets/images/social-card.png","url":"/manual/gh_search_repos"}</script>  </head> <body class="manual"> <div> <header> <nav class="d-flex flex-content-center flex-justify-between mx-auto px-3 px-md-6"> <a href="#main" class="p-3 color-bg-accent-emphasis color-fg-on-emphasis show-on-focus">Skip to content</a> <a class="d-flex mr-4 flex-items-center f4-mktg color-fg-default" href="/"> <svg viewBox="0 0 16 16" width="32" height="32" class="octicon octicon-mark-github mr-2" aria-hidden="true" role="img" > <path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path> </svg> CLI </a> <div class="d-flex flex-auto flex-items-center flex-justify-end"> <a href="/manual" class="d-inline-block f5-mktg py-4 mr-4 color-fg-default">Manual</a> <a href="https://github.com/cli/cli/releases/latest" class="d-inline-block f5-mktg py-4 mr-4 color-fg-default">Release notes</a> </div> </nav> </header> </div> <div class="d-flex flex-wrap"> <div class="col-lg-2"> <div class="height-full"> <nav aria-label="CLI commands" class="docs-nav d-none d-lg-flex flex-column p-6"> <ul class="list-style-none"> <li> <h5 class="mt-3 text-mono"> <a class="color-fg-default" href="/manual/" >Getting started</a > </h5> </li> <li> <h5 class="mt-3 text-mono"> <a class="color-fg-default" href="/manual/gh" >gh</a > </h5> </li>  <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_alias" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >alias</a> </h5> </li> <li> <a href="/manual/gh_alias_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_alias_import" class="text-mono d-block" >import</a> </li> <li> <a href="/manual/gh_alias_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_alias_set" class="text-mono d-block" >set</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_api" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >api</a> </h5> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_attestation" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >attestation</a> </h5> </li> <li> <a href="/manual/gh_attestation_download" class="text-mono d-block" >download</a> </li> <li> <a href="/manual/gh_attestation_trusted-root" class="text-mono d-block" >trusted-root</a> </li> <li> <a href="/manual/gh_attestation_verify" class="text-mono d-block" >verify</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_auth" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >auth</a> </h5> </li> <li> <a href="/manual/gh_auth_login" class="text-mono d-block" >login</a> </li> <li> <a href="/manual/gh_auth_logout" class="text-mono d-block" >logout</a> </li> <li> <a href="/manual/gh_auth_refresh" class="text-mono d-block" >refresh</a> </li> <li> <a href="/manual/gh_auth_setup-git" class="text-mono d-block" >setup-git</a> </li> <li> <a href="/manual/gh_auth_status" class="text-mono d-block" >status</a> </li> <li> <a href="/manual/gh_auth_switch" class="text-mono d-block" >switch</a> </li> <li> <a href="/manual/gh_auth_token" class="text-mono d-block" >token</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_browse" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >browse</a> </h5> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_cache" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >cache</a> </h5> </li> <li> <a href="/manual/gh_cache_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_cache_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_codespace" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >codespace</a> </h5> </li> <li> <a href="/manual/gh_codespace_code" class="text-mono d-block" >code</a> </li> <li> <a href="/manual/gh_codespace_cp" class="text-mono d-block" >cp</a> </li> <li> <a href="/manual/gh_codespace_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_codespace_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_codespace_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_codespace_jupyter" class="text-mono d-block" >jupyter</a> </li> <li> <a href="/manual/gh_codespace_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_codespace_logs" class="text-mono d-block" >logs</a> </li> <li> <a href="/manual/gh_codespace_ports" class="text-mono d-block" >ports</a> </li> <li> <a href="/manual/gh_codespace_ports_forward" class="text-mono d-block" >ports forward</a> </li> <li> <a href="/manual/gh_codespace_ports_visibility" class="text-mono d-block" >ports visibility</a> </li> <li> <a href="/manual/gh_codespace_rebuild" class="text-mono d-block" >rebuild</a> </li> <li> <a href="/manual/gh_codespace_ssh" class="text-mono d-block" >ssh</a> </li> <li> <a href="/manual/gh_codespace_stop" class="text-mono d-block" >stop</a> </li> <li> <a href="/manual/gh_codespace_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_completion" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >completion</a> </h5> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_config" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >config</a> </h5> </li> <li> <a href="/manual/gh_config_clear-cache" class="text-mono d-block" >clear-cache</a> </li> <li> <a href="/manual/gh_config_get" class="text-mono d-block" >get</a> </li> <li> <a href="/manual/gh_config_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_config_set" class="text-mono d-block" >set</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_extension" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >extension</a> </h5> </li> <li> <a href="/manual/gh_extension_browse" class="text-mono d-block" >browse</a> </li> <li> <a href="/manual/gh_extension_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_extension_exec" class="text-mono d-block" >exec</a> </li> <li> <a href="/manual/gh_extension_install" class="text-mono d-block" >install</a> </li> <li> <a href="/manual/gh_extension_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_extension_remove" class="text-mono d-block" >remove</a> </li> <li> <a href="/manual/gh_extension_search" class="text-mono d-block" >search</a> </li> <li> <a href="/manual/gh_extension_upgrade" class="text-mono d-block" >upgrade</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_gist" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >gist</a> </h5> </li> <li> <a href="/manual/gh_gist_clone" class="text-mono d-block" >clone</a> </li> <li> <a href="/manual/gh_gist_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_gist_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_gist_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_gist_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_gist_rename" class="text-mono d-block" >rename</a> </li> <li> <a href="/manual/gh_gist_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_gpg-key" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >gpg-key</a> </h5> </li> <li> <a href="/manual/gh_gpg-key_add" class="text-mono d-block" >add</a> </li> <li> <a href="/manual/gh_gpg-key_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_gpg-key_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_help" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >help</a> </h5> </li> <li> <a href="/manual/gh_help_environment" class="text-mono d-block" >environment</a> </li> <li> <a href="/manual/gh_help_exit-codes" class="text-mono d-block" >exit-codes</a> </li> <li> <a href="/manual/gh_help_formatting" class="text-mono d-block" >formatting</a> </li> <li> <a href="/manual/gh_help_mintty" class="text-mono d-block" >mintty</a> </li> <li> <a href="/manual/gh_help_reference" class="text-mono d-block" >reference</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_issue" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >issue</a> </h5> </li> <li> <a href="/manual/gh_issue_close" class="text-mono d-block" >close</a> </li> <li> <a href="/manual/gh_issue_comment" class="text-mono d-block" >comment</a> </li> <li> <a href="/manual/gh_issue_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_issue_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_issue_develop" class="text-mono d-block" >develop</a> </li> <li> <a href="/manual/gh_issue_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_issue_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_issue_lock" class="text-mono d-block" >lock</a> </li> <li> <a href="/manual/gh_issue_pin" class="text-mono d-block" >pin</a> </li> <li> <a href="/manual/gh_issue_reopen" class="text-mono d-block" >reopen</a> </li> <li> <a href="/manual/gh_issue_status" class="text-mono d-block" >status</a> </li> <li> <a href="/manual/gh_issue_transfer" class="text-mono d-block" >transfer</a> </li> <li> <a href="/manual/gh_issue_unlock" class="text-mono d-block" >unlock</a> </li> <li> <a href="/manual/gh_issue_unpin" class="text-mono d-block" >unpin</a> </li> <li> <a href="/manual/gh_issue_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_label" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >label</a> </h5> </li> <li> <a href="/manual/gh_label_clone" class="text-mono d-block" >clone</a> </li> <li> <a href="/manual/gh_label_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_label_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_label_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_label_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_org" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >org</a> </h5> </li> <li> <a href="/manual/gh_org_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_pr" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >pr</a> </h5> </li> <li> <a href="/manual/gh_pr_checkout" class="text-mono d-block" >checkout</a> </li> <li> <a href="/manual/gh_pr_checks" class="text-mono d-block" >checks</a> </li> <li> <a href="/manual/gh_pr_close" class="text-mono d-block" >close</a> </li> <li> <a href="/manual/gh_pr_comment" class="text-mono d-block" >comment</a> </li> <li> <a href="/manual/gh_pr_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_pr_diff" class="text-mono d-block" >diff</a> </li> <li> <a href="/manual/gh_pr_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_pr_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_pr_lock" class="text-mono d-block" >lock</a> </li> <li> <a href="/manual/gh_pr_merge" class="text-mono d-block" >merge</a> </li> <li> <a href="/manual/gh_pr_ready" class="text-mono d-block" >ready</a> </li> <li> <a href="/manual/gh_pr_reopen" class="text-mono d-block" >reopen</a> </li> <li> <a href="/manual/gh_pr_review" class="text-mono d-block" >review</a> </li> <li> <a href="/manual/gh_pr_status" class="text-mono d-block" >status</a> </li> <li> <a href="/manual/gh_pr_unlock" class="text-mono d-block" >unlock</a> </li> <li> <a href="/manual/gh_pr_update-branch" class="text-mono d-block" >update-branch</a> </li> <li> <a href="/manual/gh_pr_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_project" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >project</a> </h5> </li> <li> <a href="/manual/gh_project_close" class="text-mono d-block" >close</a> </li> <li> <a href="/manual/gh_project_copy" class="text-mono d-block" >copy</a> </li> <li> <a href="/manual/gh_project_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_project_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_project_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_project_field-create" class="text-mono d-block" >field-create</a> </li> <li> <a href="/manual/gh_project_field-delete" class="text-mono d-block" >field-delete</a> </li> <li> <a href="/manual/gh_project_field-list" class="text-mono d-block" >field-list</a> </li> <li> <a href="/manual/gh_project_item-add" class="text-mono d-block" >item-add</a> </li> <li> <a href="/manual/gh_project_item-archive" class="text-mono d-block" >item-archive</a> </li> <li> <a href="/manual/gh_project_item-create" class="text-mono d-block" >item-create</a> </li> <li> <a href="/manual/gh_project_item-delete" class="text-mono d-block" >item-delete</a> </li> <li> <a href="/manual/gh_project_item-edit" class="text-mono d-block" >item-edit</a> </li> <li> <a href="/manual/gh_project_item-list" class="text-mono d-block" >item-list</a> </li> <li> <a href="/manual/gh_project_link" class="text-mono d-block" >link</a> </li> <li> <a href="/manual/gh_project_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_project_mark-template" class="text-mono d-block" >mark-template</a> </li> <li> <a href="/manual/gh_project_unlink" class="text-mono d-block" >unlink</a> </li> <li> <a href="/manual/gh_project_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_release" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >release</a> </h5> </li> <li> <a href="/manual/gh_release_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_release_delete-asset" class="text-mono d-block" >delete-asset</a> </li> <li> <a href="/manual/gh_release_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_release_download" class="text-mono d-block" >download</a> </li> <li> <a href="/manual/gh_release_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_release_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_release_upload" class="text-mono d-block" >upload</a> </li> <li> <a href="/manual/gh_release_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_repo" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >repo</a> </h5> </li> <li> <a href="/manual/gh_repo_archive" class="text-mono d-block" >archive</a> </li> <li> <a href="/manual/gh_repo_clone" class="text-mono d-block" >clone</a> </li> <li> <a href="/manual/gh_repo_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_repo_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_repo_deploy-key" class="text-mono d-block" >deploy-key</a> </li> <li> <a href="/manual/gh_repo_deploy-key_add" class="text-mono d-block" >deploy-key add</a> </li> <li> <a href="/manual/gh_repo_deploy-key_delete" class="text-mono d-block" >deploy-key delete</a> </li> <li> <a href="/manual/gh_repo_deploy-key_list" class="text-mono d-block" >deploy-key list</a> </li> <li> <a href="/manual/gh_repo_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_repo_fork" class="text-mono d-block" >fork</a> </li> <li> <a href="/manual/gh_repo_gitignore" class="text-mono d-block" >gitignore</a> </li> <li> <a href="/manual/gh_repo_gitignore_list" class="text-mono d-block" >gitignore list</a> </li> <li> <a href="/manual/gh_repo_gitignore_view" class="text-mono d-block" >gitignore view</a> </li> <li> <a href="/manual/gh_repo_license" class="text-mono d-block" >license</a> </li> <li> <a href="/manual/gh_repo_license_list" class="text-mono d-block" >license list</a> </li> <li> <a href="/manual/gh_repo_license_view" class="text-mono d-block" >license view</a> </li> <li> <a href="/manual/gh_repo_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_repo_rename" class="text-mono d-block" >rename</a> </li> <li> <a href="/manual/gh_repo_set-default" class="text-mono d-block" >set-default</a> </li> <li> <a href="/manual/gh_repo_sync" class="text-mono d-block" >sync</a> </li> <li> <a href="/manual/gh_repo_unarchive" class="text-mono d-block" >unarchive</a> </li> <li> <a href="/manual/gh_repo_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_ruleset" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >ruleset</a> </h5> </li> <li> <a href="/manual/gh_ruleset_check" class="text-mono d-block" >check</a> </li> <li> <a href="/manual/gh_ruleset_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_ruleset_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_run" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >run</a> </h5> </li> <li> <a href="/manual/gh_run_cancel" class="text-mono d-block" >cancel</a> </li> <li> <a href="/manual/gh_run_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_run_download" class="text-mono d-block" >download</a> </li> <li> <a href="/manual/gh_run_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_run_rerun" class="text-mono d-block" >rerun</a> </li> <li> <a href="/manual/gh_run_view" class="text-mono d-block" >view</a> </li> <li> <a href="/manual/gh_run_watch" class="text-mono d-block" >watch</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_search" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >search</a> </h5> </li> <li> <a href="/manual/gh_search_code" class="text-mono d-block" >code</a> </li> <li> <a href="/manual/gh_search_commits" class="text-mono d-block" >commits</a> </li> <li> <a href="/manual/gh_search_issues" class="text-mono d-block" >issues</a> </li> <li> <a href="/manual/gh_search_prs" class="text-mono d-block" >prs</a> </li> <li> <a href="/manual/gh_search_repos" class="text-mono d-block" style="font-weight:bold" aria-current="page" >repos</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_secret" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >secret</a> </h5> </li> <li> <a href="/manual/gh_secret_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_secret_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_secret_set" class="text-mono d-block" >set</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_ssh-key" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >ssh-key</a> </h5> </li> <li> <a href="/manual/gh_ssh-key_add" class="text-mono d-block" >add</a> </li> <li> <a href="/manual/gh_ssh-key_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_ssh-key_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_status" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >status</a> </h5> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_variable" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >variable</a> </h5> </li> <li> <a href="/manual/gh_variable_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_variable_get" class="text-mono d-block" >get</a> </li> <li> <a href="/manual/gh_variable_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_variable_set" class="text-mono d-block" >set</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_workflow" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >workflow</a> </h5> </li> <li> <a href="/manual/gh_workflow_disable" class="text-mono d-block" >disable</a> </li> <li> <a href="/manual/gh_workflow_enable" class="text-mono d-block" >enable</a> </li> <li> <a href="/manual/gh_workflow_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_workflow_run" class="text-mono d-block" >run</a> </li> <li> <a href="/manual/gh_workflow_view" class="text-mono d-block" >view</a> </li> </ul> </nav> </div> </div> <details class="docs-nav docs-nav-mobile details-reset d-lg-none"> <summary class="color-bg-default position-fixed text-center left-0 right-0 bottom-0 p-3" style="z-index: 100;"> <svg viewBox="0 0 16 16" width="16" height="16" class="octicon octicon-three-bars" aria-hidden="true"> <path d="M1 2.75A.75.75 0 0 1 1.75 2h12.5a.75.75 0 0 1 0 1.5H1.75A.75.75 0 0 1 1 2.75Zm0 5A.75.75 0 0 1 1.75 7h12.5a.75.75 0 0 1 0 1.5H1.75A.75.75 0 0 1 1 7.75ZM1.75 12h12.5a.75.75 0 0 1 0 1.5H1.75a.75.75 0 0 1 0-1.5Z"></path> </svg> <span class="pl-2">CLI manual</span> </summary> <details-menu class="position-absolute top-0 width-full color-bg-subtle" style="z-index: 50"> <nav aria-label="CLI commands" class="px-3 py-5 pb-12"> <ul class="list-style-none"> <li> <h5 class="mt-3 text-mono"> <a class="color-fg-default" href="/manual/" >Getting started</a > </h5> </li> <li> <h5 class="mt-3 text-mono"> <a class="color-fg-default" href="/manual/gh" >gh</a > </h5> </li>  <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_alias" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >alias</a> </h5> </li> <li> <a href="/manual/gh_alias_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_alias_import" class="text-mono d-block" >import</a> </li> <li> <a href="/manual/gh_alias_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_alias_set" class="text-mono d-block" >set</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_api" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >api</a> </h5> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_attestation" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >attestation</a> </h5> </li> <li> <a href="/manual/gh_attestation_download" class="text-mono d-block" >download</a> </li> <li> <a href="/manual/gh_attestation_trusted-root" class="text-mono d-block" >trusted-root</a> </li> <li> <a href="/manual/gh_attestation_verify" class="text-mono d-block" >verify</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_auth" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >auth</a> </h5> </li> <li> <a href="/manual/gh_auth_login" class="text-mono d-block" >login</a> </li> <li> <a href="/manual/gh_auth_logout" class="text-mono d-block" >logout</a> </li> <li> <a href="/manual/gh_auth_refresh" class="text-mono d-block" >refresh</a> </li> <li> <a href="/manual/gh_auth_setup-git" class="text-mono d-block" >setup-git</a> </li> <li> <a href="/manual/gh_auth_status" class="text-mono d-block" >status</a> </li> <li> <a href="/manual/gh_auth_switch" class="text-mono d-block" >switch</a> </li> <li> <a href="/manual/gh_auth_token" class="text-mono d-block" >token</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_browse" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >browse</a> </h5> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_cache" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >cache</a> </h5> </li> <li> <a href="/manual/gh_cache_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_cache_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_codespace" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >codespace</a> </h5> </li> <li> <a href="/manual/gh_codespace_code" class="text-mono d-block" >code</a> </li> <li> <a href="/manual/gh_codespace_cp" class="text-mono d-block" >cp</a> </li> <li> <a href="/manual/gh_codespace_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_codespace_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_codespace_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_codespace_jupyter" class="text-mono d-block" >jupyter</a> </li> <li> <a href="/manual/gh_codespace_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_codespace_logs" class="text-mono d-block" >logs</a> </li> <li> <a href="/manual/gh_codespace_ports" class="text-mono d-block" >ports</a> </li> <li> <a href="/manual/gh_codespace_ports_forward" class="text-mono d-block" >ports forward</a> </li> <li> <a href="/manual/gh_codespace_ports_visibility" class="text-mono d-block" >ports visibility</a> </li> <li> <a href="/manual/gh_codespace_rebuild" class="text-mono d-block" >rebuild</a> </li> <li> <a href="/manual/gh_codespace_ssh" class="text-mono d-block" >ssh</a> </li> <li> <a href="/manual/gh_codespace_stop" class="text-mono d-block" >stop</a> </li> <li> <a href="/manual/gh_codespace_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_completion" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >completion</a> </h5> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_config" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >config</a> </h5> </li> <li> <a href="/manual/gh_config_clear-cache" class="text-mono d-block" >clear-cache</a> </li> <li> <a href="/manual/gh_config_get" class="text-mono d-block" >get</a> </li> <li> <a href="/manual/gh_config_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_config_set" class="text-mono d-block" >set</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_extension" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >extension</a> </h5> </li> <li> <a href="/manual/gh_extension_browse" class="text-mono d-block" >browse</a> </li> <li> <a href="/manual/gh_extension_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_extension_exec" class="text-mono d-block" >exec</a> </li> <li> <a href="/manual/gh_extension_install" class="text-mono d-block" >install</a> </li> <li> <a href="/manual/gh_extension_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_extension_remove" class="text-mono d-block" >remove</a> </li> <li> <a href="/manual/gh_extension_search" class="text-mono d-block" >search</a> </li> <li> <a href="/manual/gh_extension_upgrade" class="text-mono d-block" >upgrade</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_gist" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >gist</a> </h5> </li> <li> <a href="/manual/gh_gist_clone" class="text-mono d-block" >clone</a> </li> <li> <a href="/manual/gh_gist_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_gist_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_gist_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_gist_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_gist_rename" class="text-mono d-block" >rename</a> </li> <li> <a href="/manual/gh_gist_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_gpg-key" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >gpg-key</a> </h5> </li> <li> <a href="/manual/gh_gpg-key_add" class="text-mono d-block" >add</a> </li> <li> <a href="/manual/gh_gpg-key_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_gpg-key_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_help" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >help</a> </h5> </li> <li> <a href="/manual/gh_help_environment" class="text-mono d-block" >environment</a> </li> <li> <a href="/manual/gh_help_exit-codes" class="text-mono d-block" >exit-codes</a> </li> <li> <a href="/manual/gh_help_formatting" class="text-mono d-block" >formatting</a> </li> <li> <a href="/manual/gh_help_mintty" class="text-mono d-block" >mintty</a> </li> <li> <a href="/manual/gh_help_reference" class="text-mono d-block" >reference</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_issue" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >issue</a> </h5> </li> <li> <a href="/manual/gh_issue_close" class="text-mono d-block" >close</a> </li> <li> <a href="/manual/gh_issue_comment" class="text-mono d-block" >comment</a> </li> <li> <a href="/manual/gh_issue_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_issue_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_issue_develop" class="text-mono d-block" >develop</a> </li> <li> <a href="/manual/gh_issue_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_issue_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_issue_lock" class="text-mono d-block" >lock</a> </li> <li> <a href="/manual/gh_issue_pin" class="text-mono d-block" >pin</a> </li> <li> <a href="/manual/gh_issue_reopen" class="text-mono d-block" >reopen</a> </li> <li> <a href="/manual/gh_issue_status" class="text-mono d-block" >status</a> </li> <li> <a href="/manual/gh_issue_transfer" class="text-mono d-block" >transfer</a> </li> <li> <a href="/manual/gh_issue_unlock" class="text-mono d-block" >unlock</a> </li> <li> <a href="/manual/gh_issue_unpin" class="text-mono d-block" >unpin</a> </li> <li> <a href="/manual/gh_issue_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_label" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >label</a> </h5> </li> <li> <a href="/manual/gh_label_clone" class="text-mono d-block" >clone</a> </li> <li> <a href="/manual/gh_label_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_label_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_label_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_label_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_org" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >org</a> </h5> </li> <li> <a href="/manual/gh_org_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_pr" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >pr</a> </h5> </li> <li> <a href="/manual/gh_pr_checkout" class="text-mono d-block" >checkout</a> </li> <li> <a href="/manual/gh_pr_checks" class="text-mono d-block" >checks</a> </li> <li> <a href="/manual/gh_pr_close" class="text-mono d-block" >close</a> </li> <li> <a href="/manual/gh_pr_comment" class="text-mono d-block" >comment</a> </li> <li> <a href="/manual/gh_pr_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_pr_diff" class="text-mono d-block" >diff</a> </li> <li> <a href="/manual/gh_pr_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_pr_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_pr_lock" class="text-mono d-block" >lock</a> </li> <li> <a href="/manual/gh_pr_merge" class="text-mono d-block" >merge</a> </li> <li> <a href="/manual/gh_pr_ready" class="text-mono d-block" >ready</a> </li> <li> <a href="/manual/gh_pr_reopen" class="text-mono d-block" >reopen</a> </li> <li> <a href="/manual/gh_pr_review" class="text-mono d-block" >review</a> </li> <li> <a href="/manual/gh_pr_status" class="text-mono d-block" >status</a> </li> <li> <a href="/manual/gh_pr_unlock" class="text-mono d-block" >unlock</a> </li> <li> <a href="/manual/gh_pr_update-branch" class="text-mono d-block" >update-branch</a> </li> <li> <a href="/manual/gh_pr_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_project" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >project</a> </h5> </li> <li> <a href="/manual/gh_project_close" class="text-mono d-block" >close</a> </li> <li> <a href="/manual/gh_project_copy" class="text-mono d-block" >copy</a> </li> <li> <a href="/manual/gh_project_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_project_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_project_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_project_field-create" class="text-mono d-block" >field-create</a> </li> <li> <a href="/manual/gh_project_field-delete" class="text-mono d-block" >field-delete</a> </li> <li> <a href="/manual/gh_project_field-list" class="text-mono d-block" >field-list</a> </li> <li> <a href="/manual/gh_project_item-add" class="text-mono d-block" >item-add</a> </li> <li> <a href="/manual/gh_project_item-archive" class="text-mono d-block" >item-archive</a> </li> <li> <a href="/manual/gh_project_item-create" class="text-mono d-block" >item-create</a> </li> <li> <a href="/manual/gh_project_item-delete" class="text-mono d-block" >item-delete</a> </li> <li> <a href="/manual/gh_project_item-edit" class="text-mono d-block" >item-edit</a> </li> <li> <a href="/manual/gh_project_item-list" class="text-mono d-block" >item-list</a> </li> <li> <a href="/manual/gh_project_link" class="text-mono d-block" >link</a> </li> <li> <a href="/manual/gh_project_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_project_mark-template" class="text-mono d-block" >mark-template</a> </li> <li> <a href="/manual/gh_project_unlink" class="text-mono d-block" >unlink</a> </li> <li> <a href="/manual/gh_project_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_release" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >release</a> </h5> </li> <li> <a href="/manual/gh_release_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_release_delete-asset" class="text-mono d-block" >delete-asset</a> </li> <li> <a href="/manual/gh_release_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_release_download" class="text-mono d-block" >download</a> </li> <li> <a href="/manual/gh_release_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_release_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_release_upload" class="text-mono d-block" >upload</a> </li> <li> <a href="/manual/gh_release_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_repo" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >repo</a> </h5> </li> <li> <a href="/manual/gh_repo_archive" class="text-mono d-block" >archive</a> </li> <li> <a href="/manual/gh_repo_clone" class="text-mono d-block" >clone</a> </li> <li> <a href="/manual/gh_repo_create" class="text-mono d-block" >create</a> </li> <li> <a href="/manual/gh_repo_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_repo_deploy-key" class="text-mono d-block" >deploy-key</a> </li> <li> <a href="/manual/gh_repo_deploy-key_add" class="text-mono d-block" >deploy-key add</a> </li> <li> <a href="/manual/gh_repo_deploy-key_delete" class="text-mono d-block" >deploy-key delete</a> </li> <li> <a href="/manual/gh_repo_deploy-key_list" class="text-mono d-block" >deploy-key list</a> </li> <li> <a href="/manual/gh_repo_edit" class="text-mono d-block" >edit</a> </li> <li> <a href="/manual/gh_repo_fork" class="text-mono d-block" >fork</a> </li> <li> <a href="/manual/gh_repo_gitignore" class="text-mono d-block" >gitignore</a> </li> <li> <a href="/manual/gh_repo_gitignore_list" class="text-mono d-block" >gitignore list</a> </li> <li> <a href="/manual/gh_repo_gitignore_view" class="text-mono d-block" >gitignore view</a> </li> <li> <a href="/manual/gh_repo_license" class="text-mono d-block" >license</a> </li> <li> <a href="/manual/gh_repo_license_list" class="text-mono d-block" >license list</a> </li> <li> <a href="/manual/gh_repo_license_view" class="text-mono d-block" >license view</a> </li> <li> <a href="/manual/gh_repo_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_repo_rename" class="text-mono d-block" >rename</a> </li> <li> <a href="/manual/gh_repo_set-default" class="text-mono d-block" >set-default</a> </li> <li> <a href="/manual/gh_repo_sync" class="text-mono d-block" >sync</a> </li> <li> <a href="/manual/gh_repo_unarchive" class="text-mono d-block" >unarchive</a> </li> <li> <a href="/manual/gh_repo_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_ruleset" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >ruleset</a> </h5> </li> <li> <a href="/manual/gh_ruleset_check" class="text-mono d-block" >check</a> </li> <li> <a href="/manual/gh_ruleset_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_ruleset_view" class="text-mono d-block" >view</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_run" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >run</a> </h5> </li> <li> <a href="/manual/gh_run_cancel" class="text-mono d-block" >cancel</a> </li> <li> <a href="/manual/gh_run_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_run_download" class="text-mono d-block" >download</a> </li> <li> <a href="/manual/gh_run_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_run_rerun" class="text-mono d-block" >rerun</a> </li> <li> <a href="/manual/gh_run_view" class="text-mono d-block" >view</a> </li> <li> <a href="/manual/gh_run_watch" class="text-mono d-block" >watch</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_search" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >search</a> </h5> </li> <li> <a href="/manual/gh_search_code" class="text-mono d-block" >code</a> </li> <li> <a href="/manual/gh_search_commits" class="text-mono d-block" >commits</a> </li> <li> <a href="/manual/gh_search_issues" class="text-mono d-block" >issues</a> </li> <li> <a href="/manual/gh_search_prs" class="text-mono d-block" >prs</a> </li> <li> <a href="/manual/gh_search_repos" class="text-mono d-block" style="font-weight:bold" aria-current="page" >repos</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_secret" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >secret</a> </h5> </li> <li> <a href="/manual/gh_secret_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_secret_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_secret_set" class="text-mono d-block" >set</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_ssh-key" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >ssh-key</a> </h5> </li> <li> <a href="/manual/gh_ssh-key_add" class="text-mono d-block" >add</a> </li> <li> <a href="/manual/gh_ssh-key_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_ssh-key_list" class="text-mono d-block" >list</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_status" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >status</a> </h5> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_variable" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >variable</a> </h5> </li> <li> <a href="/manual/gh_variable_delete" class="text-mono d-block" >delete</a> </li> <li> <a href="/manual/gh_variable_get" class="text-mono d-block" >get</a> </li> <li> <a href="/manual/gh_variable_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_variable_set" class="text-mono d-block" >set</a> </li> <li> <h5 class="mt-3 text-mono"> <a href="/manual/gh_workflow" class="color-fg-default" style="font-weight:normal" class="text-mono d-block" >workflow</a> </h5> </li> <li> <a href="/manual/gh_workflow_disable" class="text-mono d-block" >disable</a> </li> <li> <a href="/manual/gh_workflow_enable" class="text-mono d-block" >enable</a> </li> <li> <a href="/manual/gh_workflow_list" class="text-mono d-block" >list</a> </li> <li> <a href="/manual/gh_workflow_run" class="text-mono d-block" >run</a> </li> <li> <a href="/manual/gh_workflow_view" class="text-mono d-block" >view</a> </li> </ul> </nav> </details-menu> </details> <main id="main" class="main-content color-bg-subtle markdown-body col-12 col-lg-10 pt-7 pb-12 px-3 px-md-6"> <div class="container-lg"> <h2 id="gh-search-repos">gh search repos</h2> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gh search repos [<query>] [flags] </code></pre></div></div> <p>Search for repositories on GitHub.</p> <p>The command supports constructing queries using the GitHub search syntax, using the parameter and qualifier flags, or a combination of the two.</p> <p>GitHub search syntax is documented at: <a href="https://docs.github.com/search-github/searching-on-github/searching-for-repositories">https://docs.github.com/search-github/searching-on-github/searching-for-repositories</a></p> <h3 id="options">Options</h3> <dl class="flags"> <dt> <code>--archived</code></dt> <dd>Filter based on the repository archived state {true|false}</dd> <dt> <code>--created <date></code></dt> <dd>Filter based on created at date</dd> <dt> <code>--followers <number></code></dt> <dd>Filter based on number of followers</dd> <dt> <code>--forks <number></code></dt> <dd>Filter on number of forks</dd> <dt> <code>--good-first-issues <number></code></dt> <dd>Filter on number of issues with the 'good first issue' label</dd> <dt> <code>--help-wanted-issues <number></code></dt> <dd>Filter on number of issues with the 'help wanted' label</dd> <dt> <code>--include-forks <string></code></dt> <dd>Include forks in fetched repositories: {false|true|only}</dd> <dt><code>-q</code>, <code>--jq <expression></code></dt> <dd>Filter JSON output using a jq expression</dd> <dt> <code>--json <fields></code></dt> <dd>Output JSON with the specified fields</dd> <dt> <code>--language <string></code></dt> <dd>Filter based on the coding language</dd> <dt> <code>--license <strings></code></dt> <dd>Filter based on license type</dd> <dt><code>-L</code>, <code>--limit <int> (default 30)</code></dt> <dd>Maximum number of repositories to fetch</dd> <dt> <code>--match <strings></code></dt> <dd>Restrict search to specific field of repository: {name|description|readme}</dd> <dt> <code>--number-topics <number></code></dt> <dd>Filter on number of topics</dd> <dt> <code>--order <string> (default "desc")</code></dt> <dd>Order of repositories returned, ignored unless '--sort' flag is specified: {asc|desc}</dd> <dt> <code>--owner <strings></code></dt> <dd>Filter on owner</dd> <dt> <code>--size <string></code></dt> <dd>Filter on a size range, in kilobytes</dd> <dt> <code>--sort <string> (default "best-match")</code></dt> <dd>Sort fetched repositories: {forks|help-wanted-issues|stars|updated}</dd> <dt> <code>--stars <number></code></dt> <dd>Filter on number of stars</dd> <dt><code>-t</code>, <code>--template <string></code></dt> <dd>Format JSON output using a Go template; see "gh help formatting"</dd> <dt> <code>--topic <strings></code></dt> <dd>Filter on topic</dd> <dt> <code>--updated <date></code></dt> <dd>Filter on last updated at date</dd> <dt> <code>--visibility <strings></code></dt> <dd>Filter based on visibility: {public|private|internal}</dd> <dt><code>-w</code>, <code>--web</code></dt> <dd>Open the search query in the web browser</dd> </dl> <h3 id="json-fields">JSON Fields</h3> <p><code class="language-plaintext highlighter-rouge">createdAt</code>, <code class="language-plaintext highlighter-rouge">defaultBranch</code>, <code class="language-plaintext highlighter-rouge">description</code>, <code class="language-plaintext highlighter-rouge">forksCount</code>, <code class="language-plaintext highlighter-rouge">fullName</code>, <code class="language-plaintext highlighter-rouge">hasDownloads</code>, <code class="language-plaintext highlighter-rouge">hasIssues</code>, <code class="language-plaintext highlighter-rouge">hasPages</code>, <code class="language-plaintext highlighter-rouge">hasProjects</code>, <code class="language-plaintext highlighter-rouge">hasWiki</code>, <code class="language-plaintext highlighter-rouge">homepage</code>, <code class="language-plaintext highlighter-rouge">id</code>, <code class="language-plaintext highlighter-rouge">isArchived</code>, <code class="language-plaintext highlighter-rouge">isDisabled</code>, <code class="language-plaintext highlighter-rouge">isFork</code>, <code class="language-plaintext highlighter-rouge">isPrivate</code>, <code class="language-plaintext highlighter-rouge">language</code>, <code class="language-plaintext highlighter-rouge">license</code>, <code class="language-plaintext highlighter-rouge">name</code>, <code class="language-plaintext highlighter-rouge">openIssuesCount</code>, <code class="language-plaintext highlighter-rouge">owner</code>, <code class="language-plaintext highlighter-rouge">pushedAt</code>, <code class="language-plaintext highlighter-rouge">size</code>, <code class="language-plaintext highlighter-rouge">stargazersCount</code>, <code class="language-plaintext highlighter-rouge">updatedAt</code>, <code class="language-plaintext highlighter-rouge">url</code>, <code class="language-plaintext highlighter-rouge">visibility</code>, <code class="language-plaintext highlighter-rouge">watchersCount</code></p> <h3 id="examples">Examples</h3> <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="c"># search repositories matching set of keywords "cli" and "shell"</span> <span class="nv">$ </span>gh search repos cli shell <span class="c"># search repositories matching phrase "vim plugin"</span> <span class="nv">$ </span>gh search repos <span class="s2">"vim plugin"</span> <span class="c"># search repositories public repos in the microsoft organization</span> <span class="nv">$ </span>gh search repos <span class="nt">--owner</span><span class="o">=</span>microsoft <span class="nt">--visibility</span><span class="o">=</span>public <span class="c"># search repositories with a set of topics</span> <span class="nv">$ </span>gh search repos <span class="nt">--topic</span><span class="o">=</span>unix,terminal <span class="c"># search repositories by coding language and number of good first issues</span> <span class="nv">$ </span>gh search repos <span class="nt">--language</span><span class="o">=</span>go <span class="nt">--good-first-issues</span><span class="o">=</span><span class="s2">">=10"</span> <span class="c"># search repositories without topic "linux"</span> <span class="nv">$ </span>gh search repos <span class="nt">--</span> <span class="nt">-topic</span>:linux <span class="c"># search repositories excluding archived repositories</span> <span class="nv">$ </span>gh search repos <span class="nt">--archived</span><span class="o">=</span><span class="nb">false</span></code></pre></figure> <h3 id="see-also">See also</h3> <ul> <li><a href="./gh_search">gh search</a></li> </ul> </div> </div> <footer data-color-mode="light" data-light-theme="light" class="col-12 mb-lg-0 pb-lg-0 py-lg-0"> <div class="container-xl px-3 px-md-4"> <nav aria-label="footer"> <div class="d-flex flex-wrap py-5 mb-5"> <div class="col-12 col-lg-4 mb-5"> <a href="https://github.com/" class="color-fg-default" aria-label="GitHub"> <svg viewBox="0 0 45 16" width="84" height="30" class="octicon octicon-logo-github" aria-hidden="true"> <path d="M8.81 7.35v5.74c0 .04-.01.11-.06.13 0 0-1.25.89-3.31.89-2.49 0-5.44-.78-5.44-5.92S2.58 1.99 5.1 2c2.18 0 3.06.49 3.2.58.04.05.06.09.06.14L7.94 4.5c0 .09-.09.2-.2.17-.36-.11-.9-.33-2.17-.33-1.47 0-3.05.42-3.05 3.73s1.5 3.7 2.58 3.7c.92 0 1.25-.11 1.25-.11v-2.3H4.88c-.11 0-.19-.08-.19-.17V7.35c0-.09.08-.17.19-.17h3.74c.11 0 .19.08.19.17Zm35.85 2.33c0 3.43-1.11 4.41-3.05 4.41-1.64 0-2.52-.83-2.52-.83s-.04.46-.09.52c-.03.06-.08.08-.14.08h-1.48c-.1 0-.19-.08-.19-.17l.02-11.11c0-.09.08-.17.17-.17h2.13c.09 0 .17.08.17.17v3.77s.82-.53 2.02-.53l-.01-.02c1.2 0 2.97.45 2.97 3.88ZM27.68 2.43c.09 0 .17.08.17.17v11.11c0 .09-.08.17-.17.17h-2.13c-.09 0-.17-.08-.17-.17l.02-4.75h-3.31v4.75c0 .09-.08.17-.17.17h-2.13c-.08 0-.17-.08-.17-.17V2.6c0-.09.08-.17.17-.17h2.13c.09 0 .17.08.17.17v4.09h3.31V2.6c0-.09.08-.17.17-.17Zm8.26 3.64c.11 0 .19.08.19.17l-.02 7.47c0 .09-.06.17-.17.17H34.6c-.07 0-.14-.04-.16-.09-.03-.06-.08-.45-.08-.45s-1.13.77-2.52.77c-1.69 0-2.92-.55-2.92-2.75V6.25c0-.09.08-.17.17-.17h2.14c.09 0 .17.08.17.17V11c0 .75.22 1.09.97 1.09s1.3-.39 1.3-.39V6.26c0-.11.06-.19.17-.19Zm-17.406 5.971h.005a.177.177 0 0 1 .141.179v1.5c0 .07-.03.14-.09.16-.1.05-.74.22-1.27.22-1.16 0-2.86-.25-2.86-2.69V8.13h-1.11c-.09 0-.17-.08-.17-.19V6.58c0-.08.05-.15.13-.17.07-.01 1.16-.28 1.16-.28V3.96c0-.08.05-.13.14-.13h2.16c.09 0 .14.05.14.13v2.11h1.59c.08 0 .16.08.16.17v1.7c0 .11-.07.19-.16.19h-1.59v3.131c0 .47.27.83 1.05.83.247 0 .481-.049.574-.05ZM12.24 6.06c.09 0 .17.08.17.17v7.37c0 .18-.05.27-.25.27h-1.92c-.17 0-.3-.07-.3-.27V6.26c0-.11.08-.2.17-.2Zm29.99 3.78c0-1.81-.73-2.05-1.5-1.97-.6.04-1.08.34-1.08.34v3.52s.49.34 1.22.36c1.03.03 1.36-.34 1.36-2.25ZM11.19 2.68c.75 0 1.36.61 1.36 1.38 0 .77-.61 1.38-1.36 1.38-.77 0-1.38-.61-1.38-1.38 0-.77.61-1.38 1.38-1.38Zm7.34 9.35v.001l.01.01h-.001l-.005-.001v.001c-.009-.001-.015-.011-.024-.011Z"></path> </svg> </a> </div> <div class="col-6 col-sm-3 col-lg-2 mb-6 mb-md-2 pr-3 pr-lg-0 pl-lg-4"> <h4 id="product-header" class="mb-3 text-mono text-normal">Product</h4> <ul class="list-style-none f5" aria-labelledby="product-header"> <li class="lh-condensed mb-3"><a href="https://github.com/features" class="color-fg-subtle">Features</a></li> <li class="lh-condensed mb-3"><a href="https://github.com/security" class="color-fg-subtle">Security</a></li> <li class="lh-condensed mb-3"> <a href="https://github.com/enterprise" class="color-fg-subtle">Enterprise</a> </li> <li class="lh-condensed mb-3"> <a href="https://github.com/customer-stories" class="color-fg-subtle">Customer stories</a> </li> <li class="lh-condensed mb-3"><a href="https://github.com/pricing" class="color-fg-subtle">Pricing</a></li> <li class="lh-condensed mb-3"> <a href="https://resources.github.com" class="color-fg-subtle">Resources</a> </li> </ul> </div> <div class="col-6 col-sm-3 col-lg-2 mb-6 mb-md-2 pr-3 pr-md-0 pl-md-4"> <h4 id="platform-header" class="mb-3 text-mono text-normal">Platform</h4> <ul class="list-style-none f5" aria-labelledby="platform-header"> <li class="lh-condensed mb-3"> <a href="https://developer.github.com/" class="color-fg-subtle">Developer API</a> </li> <li class="lh-condensed mb-3"><a href="http://partner.github.com/" class="color-fg-subtle">Partners</a></li> <li class="lh-condensed mb-3"> <a href="https://desktop.github.com/" class="color-fg-subtle">GitHub Desktop</a> </li> <li class="lh-condensed mb-3"> <a href="https://github.com/mobile" class="color-fg-subtle">GitHub Mobile</a> </li> </ul> </div> <div class="col-6 col-sm-3 col-lg-2 mb-6 mb-md-2 pr-3 pr-md-0 pl-md-4"> <h4 id="support-header" class="mb-3 text-mono text-normal">Support</h4> <ul class="list-style-none f5" aria-labelledby="support-header"> <li class="lh-condensed mb-3"><a href="https://help.github.com/en" class="color-fg-subtle">Help</a></li> <li class="lh-condensed mb-3"> <a href="https://github.community" class="color-fg-subtle">Community Forum</a> </li> <li class="lh-condensed mb-3"> <a href="https://github.com/services/" class="color-fg-subtle">Expert Services</a> </li> <li class="lh-condensed mb-3"><a href="https://githubstatus.com/" class="color-fg-subtle">Status</a></li> <li class="lh-condensed mb-3"> <a href="https://github.com/contact" class="color-fg-subtle">Contact GitHub</a> </li> </ul> </div> <div class="col-6 col-sm-3 col-lg-2 mb-6 mb-md-2 pr-3 pr-md-0 pl-md-4"> <h4 id="company-header" class="mb-3 text-mono text-normal">Company</h4> <ul class="list-style-none f5" aria-labelledby="company-header"> <li class="lh-condensed mb-3"><a href="https://github.com/about" class="color-fg-subtle">About</a></li> <li class="lh-condensed mb-3"><a href="https://github.blog/" class="color-fg-subtle">Blog</a></li> <li class="lh-condensed mb-3"> <a href="https://github.com/about/careers" class="color-fg-subtle">Careers</a> </li> <li class="lh-condensed mb-3"><a href="https://github.com/about/press" class="color-fg-subtle">Press</a></li> <li class="lh-condensed mb-3"><a href="https://shop.github.com" class="color-fg-subtle">Shop</a></li> </ul> </div> </div> </nav> </div> <div class="color-bg-subtle"> <div class="container-xl px-3 px-md-4 f6 py-4 d-sm-flex flex-justify-between flex-row flex-items-center"> <ul class="list-style-none d-flex"> <li class="mr-3 color-fg-subtle">© 2024 GitHub, Inc.</li> <li class="mr-3"> <a href="https://help.github.com/en/articles/github-terms-of-service/" class="color-fg-subtle">Terms </a> </li> <li> <a href="https://help.github.com/en/articles/github-privacy-statement/" class="color-fg-subtle">Privacy</a> </li> </ul> <ul class="list-style-none d-flex flex-items-center mb-3 mb-sm-0 lh-condensed-ultra"> <li class="mr-3"> <a href="https://twitter.com/github" title="GitHub on Twitter" class="color-fg-subtle"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 273.5 222.3" class="d-block" height="18"> <path d="M273.5 26.3a109.77 109.77 0 0 1-32.2 8.8 56.07 56.07 0 0 0 24.7-31 113.39 113.39 0 0 1-35.7 13.6 56.1 56.1 0 0 0-97 38.4 54 54 0 0 0 1.5 12.8A159.68 159.68 0 0 1 19.1 10.3a56.12 56.12 0 0 0 17.4 74.9 56.06 56.06 0 0 1-25.4-7v.7a56.11 56.11 0 0 0 45 55 55.65 55.65 0 0 1-14.8 2 62.39 62.39 0 0 1-10.6-1 56.24 56.24 0 0 0 52.4 39 112.87 112.87 0 0 1-69.7 24 119 119 0 0 1-13.4-.8 158.83 158.83 0 0 0 86 25.2c103.2 0 159.6-85.5 159.6-159.6 0-2.4-.1-4.9-.2-7.3a114.25 114.25 0 0 0 28.1-29.1" fill="currentColor"></path> </svg> </a> </li> <li class="mr-3"> <a href="https://www.facebook.com/GitHub" title="GitHub on Facebook" class="color-fg-subtle"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 15.3 15.4" class="d-block" height="18"> <path d="M14.5 0H.8a.88.88 0 0 0-.8.9v13.6a.88.88 0 0 0 .8.9h7.3v-6h-2V7.1h2V5.4a2.87 2.87 0 0 1 2.5-3.1h.5a10.87 10.87 0 0 1 1.8.1v2.1h-1.3c-1 0-1.1.5-1.1 1.1v1.5h2.3l-.3 2.3h-2v5.9h3.9a.88.88 0 0 0 .9-.8V.8a.86.86 0 0 0-.8-.8z" fill="currentColor"></path> </svg> </a> </li> <li class="mr-3"> <a href="https://www.youtube.com/github" title="GitHub on YouTube" class="color-fg-subtle"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.17 13.6" class="d-block" height="16"> <path d="M18.77 2.13A2.4 2.4 0 0 0 17.09.42C15.59 0 9.58 0 9.58 0a57.55 57.55 0 0 0-7.5.4A2.49 2.49 0 0 0 .39 2.13 26.27 26.27 0 0 0 0 6.8a26.15 26.15 0 0 0 .39 4.67 2.43 2.43 0 0 0 1.69 1.71c1.52.42 7.5.42 7.5.42a57.69 57.69 0 0 0 7.51-.4 2.4 2.4 0 0 0 1.68-1.71 25.63 25.63 0 0 0 .4-4.67 24 24 0 0 0-.4-4.69zM7.67 9.71V3.89l5 2.91z" fill="currentColor"></path> </svg> </a> </li> <li class="mr-3 flex-self-start"> <a href="https://www.linkedin.com/company/github" title="GitHub on Linkedin" class="color-fg-subtle"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19 18" class="d-block" height="18"> <path d="M3.94 2A2 2 0 1 1 2 0a2 2 0 0 1 1.94 2zM4 5.48H0V18h4zm6.32 0H6.34V18h3.94v-6.57c0-3.66 4.77-4 4.77 0V18H19v-7.93c0-6.17-7.06-5.94-8.72-2.91z" fill="currentColor"></path> </svg> </a> </li> <li> <a href="https://github.com/github" title="GitHub's organization" class="color-fg-subtle"> <svg viewBox="0 0 16 16" width="20" height="20" class="octicon octicon-mark-github d-block" alt="GitHub" aria-hidden="true" > <path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path> </svg> </a> </li> </ul> </div> </div> </footer> <script src="/assets/dist.js?1732742030"></script> </div> </body> </html>

CINXE.COM

GitHub CLI | Take GitHub to the command line