{"props":{"pageProps":{"mainContext":{"allVersions":{"free-pro-team@latest":{"version":"free-pro-team@latest","versionTitle":"Free, Pro, \u0026 Team","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28"},"enterprise-cloud@latest":{"version":"enterprise-cloud@latest","versionTitle":"Enterprise Cloud","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28"},"enterprise-server@3.17":{"version":"enterprise-server@3.17","versionTitle":"Enterprise Server 3.17","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28","isGHES":true},"enterprise-server@3.16":{"version":"enterprise-server@3.16","versionTitle":"Enterprise Server 3.16","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28","isGHES":true},"enterprise-server@3.15":{"version":"enterprise-server@3.15","versionTitle":"Enterprise Server 3.15","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28","isGHES":true},"enterprise-server@3.14":{"version":"enterprise-server@3.14","versionTitle":"Enterprise Server 3.14","apiVersions":["2022-11-28"],"latestApiVersion":"2022-11-28","isGHES":true}},"breadcrumbs":[],"communityRedirect":{},"currentCategory":"","currentLayoutName":"default","currentPathWithoutLanguage":"/","currentProduct":null,"currentProductName":"","currentProductTree":null,"currentVersion":"free-pro-team@latest","data":{"ui":{"alerts":{"NOTE":"Note","IMPORTANT":"Important","WARNING":"Warning","TIP":"Tip","CAUTION":"Caution"},"header":{"github_docs":"GitHub Docs","contact":"Contact","notices":{"release_candidate":" is currently available as a \u003ca href=\"/admin/overview/about-upgrades-to-new-releases\"\u003erelease candidate\u003c/a\u003e.","early_access":"📣 Please \u003cb\u003edo not share\u003c/b\u003e this URL publicly. This page contains content about a private preview feature.","release_notes_use_latest":"Please use the latest release for the latest security, performance, and bug fixes.","ghes_release_notes_upgrade_patch_only":"📣 This is not the \u003ca href=\"#{{ latestPatch }}\"\u003elatest patch release\u003c/a\u003e of Enterprise Server.","ghes_release_notes_upgrade_release_only":"📣 This is not the \u003ca href=\"/enterprise-server@{{ latestRelease }}/admin/release-notes\"\u003elatest release\u003c/a\u003e of Enterprise Server.","ghes_release_notes_upgrade_patch_and_release":"📣 This is not the \u003ca href=\"#{{ latestPatch }}\"\u003elatest patch release\u003c/a\u003e of this release series, and this is not the \u003ca href=\"/enterprise-server@{{ latestRelease }}/admin/release-notes\"\u003elatest release\u003c/a\u003e of Enterprise Server."},"sign_up_cta":"Sign up","menu":"Menu","open_menu_label":"Open menu","go_home":"Home"},"search":{"input":{"placeholder":"Search or ask {{icon}} Copilot","placeholder_no_icon":"Search or ask Copilot","shortcut":"Type {{icon}} to search"},"overlay":{"aria_label":"Search overlay","input_aria_label":"Search or ask Copilot","suggestions_list_aria_label":"Search suggestions","ai_suggestions_list_aria_label":"Copilot search suggestions","general_suggestions_list_aria_label":"Docs search suggestions","general_suggestions_list_heading":"Search docs","ai_autocomplete_list_heading":"Ask Copilot","give_feedback":"Give feedback","beta_tag":"Beta","return_to_search":"Return to search","clear_search_query":"Clear","view_all_search_results":"View more results","no_results_found":"No results found","no_results_found_announcement":"Search Docs: No results found","search_docs_with_query":"Search docs for \"{{query}}\"","privacy_disclaimer":"For product and service improvement purposes, the GitHub Docs team will retain questions and answers generated in the Docs search function. Please see the \u003ca href=\"https://docs.github.com/privacy\"\u003e\u003cu\u003eGitHub Privacy Statement\u003c/u\u003e\u003c/a\u003e to review how GitHub collects and uses your data."},"ai":{"disclaimer":"\u003ca href=\"https://docs.github.com/en/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-chat-in-githubcom\"}\u003eCopilot\u003c/a\u003e uses AI. Check for mistakes.","references":"Copilot Sources","loading_status_message":"Loading Copilot response...","done_loading_status_message":"Done loading Copilot response","share_answer":"Copy answer URL","share_copied_announcement":"Copied share URL!","thumbs_up":"This answer was helpful","thumbs_down":"This answer was not helpful","thumbs_announcement":"Thank you for your feedback!","back_to_search":"Back to search","responses":{"unable_to_answer":"Sorry, I'm unable to answer that question. Check that you selected the correct GitHub version or try a different question.","query_too_large":"Sorry, your question is too long. Please try shortening it and asking again.","asked_too_many_times":"Sorry, you've asked too many questions in a short time period. Please wait a few minutes and try again.","invalid_query":"Sorry, I'm unable to answer that question. Please try asking a different question."},"response":{"copy_code":"Copy code to clipboard","copied_code":"Copied!"}},"failure":{"general_title":"There was an error loading search results.","ai_title":"There was an error loading Copilot.","description":"You can still use this field to search our docs."},"cta":{"heading":"Get quick answers!","description":"Ask Copilot your question.","dismiss":"Dismiss","ask_copilot":"Ask Copilot"}},"old_search":{"description":"Enter a search term to find it in the GitHub Docs.","placeholder":"Search GitHub Docs","label":"Search GitHub Docs"},"survey":{"able_to_find":"Did you find what you needed?","yes":"Yes","no":"No","cancel":"Cancel","additional_feedback":"Can you tell us more about your rating? (Optional)","optional":"Optional","required":"Required","email_label":"Leave your email if we can contact you. (Optional)","email_validation":"Please enter a valid email address","send":"Send","feedback":"Thank you! We received your feedback.","not_support":"If you need a reply, please contact \u003ca href=\"https://support.github.com/\"\u003esupport\u003c/a\u003e.","privacy_policy":"Privacy policy","server_error":"Unable to process comment at the moment. Please try again."},"toc":{"getting_started":"Getting started","popular":"Popular","startHere":"Start here","whats_new":"What's new","videos":"Videos","all_changelogs":"All changelog posts"},"meta":{"default_description":"Get started, troubleshoot, and make the most of GitHub. Documentation for new users, developers, administrators, and all of GitHub's products."},"scroll_button":{"scroll_to_top":"Scroll to top"},"pages":{"article_version":"Article version","miniToc":"In this article","all_enterprise_releases":"All Enterprise Server releases","about_versions":"About versions","permissions_callout_title":"Who can use this feature?","video_from_transcript":"See video for this transcript"},"picker":{"language_picker_label":"Language","product_picker_default_text":"All products","version_picker_default_text":"Choose a version"},"footer":{"support_heading":"Help and support","legal_heading":"Legal","imprint":"Imprint","terms":"Terms","privacy":"Privacy","status":"Status","pricing":"Pricing","expert_services":"Expert services","blog":"Blog","machine":"Some of this content may be machine- or AI-translated."},"contribution_cta":{"title":"Help us make these docs great!","body":"All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.","button":"Make a contribution","to_guidelines":"Learn how to contribute"},"support":{"still_need_help":"Still need help?","contact_support":"Contact support","ask_community":"Ask the GitHub community"},"rest":{"banner":{"api_versioned":"The REST API is now versioned.","api_version_info":"For more information, see \"\u003ca href=\"{{ versionWithApiVersion }}/rest/overview/api-versions\"\u003eAbout API versioning\u003c/a\u003e.\"","ghes_api_versioned":"After a site administrator upgrades your Enterprise Server instance to {{ firstGhesReleaseWithApiVersions.versionTitle }} or later, the REST API will be versioned. To learn how to find your instance's version, see \"\u003ca href=\"/{{ currentVersion }}/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server\"\u003eAbout versions of GitHub Docs\u003c/a\u003e\".","redirect_notice":"We've recently moved some of the REST API documentation.","redirect_repo":"If you can't find what you're looking for, you might try the new {{ newRestPagesLinks }} REST API pages.","redirect_enterprise":"If you can't find what you're looking for, you might try the {{ actionsPageLink }} REST API page.","actions_api_title":"Actions"},"versioning":{"about_versions":"About REST API versions"},"overview":{"permissions":{"access":"Access","endpoints":"Endpoint","tokens":"Token types","additionalPermissions":"Additional permissions","uat":"UAT","iat":"IAT"}},"screen_reader_text_checkmark_icon":"Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint."},"cookbook_landing":{"spotlight":"Spotlight","explore_articles":"Explore {{ number }} prompt articles","reset_filters":"Reset filters","search_articles":"Search articles","category":"Category","complexity":"Complexity"},"homepage":{"explore_by_product":"Explore by product","version_picker":"Version","description":"Help for wherever you are on your GitHub journey."},"product_landing":{"quickstart":"Quickstart","reference":"Reference","overview":"Overview","try_ghec_for_free":"Try GitHub's enterprise features","try_ghas_for_free":"Try GitHub Advanced Security for free","generate_secret_risk_assessment_report_for_free":"Find out how to run a free secret risk assessment","plan_your_migration":"Plan your migration","releases":"Releases","guides":"Guides","explore_guides":"Explore guides","explore_people_and_projects":"Explore people and projects","sorry":"Sorry, there is no result for","no_example":"It looks like we don't have an example that fits your filter.","try_another":"Try another filter or add your code example.","no_result":"Sorry, there are no guides that match your filter.","learn":"Learn how to add a code example","communities_using_discussions":"Communities on GitHub.com using discussions","add_your_community":"Add your community","sponsor_community":"GitHub Sponsors community","supported_releases":"Supported releases","release_notes_for":"Release notes for","upgrade_from":"Upgrade from","browse_all_docs":"Browse all docs","browse_all":"Browse all","docs":"docs","explore_release_notes":"Explore release notes","view":"View all","view_transcript":"View video transcript","all_docs":"All {{ title }} docs","all_content":"View all {{ title }} content"}},"reusables":{},"variables":{"release_candidate":{"version":null}}},"enterpriseServerReleases":{"isOldestReleaseDeprecated":false,"oldestSupported":"3.14","nextDeprecationDate":"2025-08-27","supported":["3.17","3.16","3.15","3.14"]},"enterpriseServerVersions":["enterprise-server@3.17","enterprise-server@3.16","enterprise-server@3.15","enterprise-server@3.14"],"error":"","featureFlags":{},"fullUrl":"https://docs-internal.github.com/en","isHomepageVersion":true,"nonEnterpriseDefaultVersion":"free-pro-team@latest","page":{"documentType":"homepage","type":null,"title":"GitHub.com Help Documentation","fullTitle":"GitHub.com Help Documentation","topics":[],"introPlainText":null,"applicableVersions":["free-pro-team@latest","enterprise-cloud@latest","enterprise-server@3.17","enterprise-server@3.16","enterprise-server@3.15","enterprise-server@3.14"],"hidden":false,"noEarlyAccessBanner":false},"relativePath":"index.md","sidebarTree":null,"status":200,"xHost":"docs.github.com"},"productGroups":[{"name":"Get started","icon":null,"octicon":"RocketIcon","children":[{"id":"get-started","name":"Get started","href":"/en/get-started","external":false},{"id":"migrations","name":"Migrations","href":"/en/migrations","external":false},{"id":"account-and-profile","name":"Account and profile","href":"/en/account-and-profile","external":false},{"id":"subscriptions-and-notifications","name":"Subscriptions \u0026 notifications","href":"/en/subscriptions-and-notifications","external":false},{"id":"authentication","name":"Authentication","href":"/en/authentication","external":false},{"id":"billing","name":"Billing and payments","href":"/en/billing","external":false},{"id":"site-policy","name":"Site policy","href":"/en/site-policy","external":false}]},{"name":"Collaborative coding","icon":null,"octicon":"CommentDiscussionIcon","children":[{"id":"codespaces","name":"Codespaces","href":"/en/codespaces","external":false},{"id":"repositories","name":"Repositories","href":"/en/repositories","external":false},{"id":"pull-requests","name":"Pull requests","href":"/en/pull-requests","external":false},{"id":"discussions","name":"GitHub Discussions","href":"/en/discussions","external":false}]},{"name":"GitHub Copilot","icon":null,"octicon":"CopilotIcon","children":[{"id":"copilot","name":"GitHub Copilot","href":"/en/copilot","external":false},{"id":"copilot/get-started/plans","name":"Plans","href":"/en/copilot/get-started/plans","external":false},{"id":"copilot/how-tos/get-code-suggestions/get-code-suggestions","name":"Get code suggestions","href":"/en/copilot/how-tos/get-code-suggestions/get-code-suggestions","external":false},{"id":"copilot/tutorials/copilot-chat-cookbook","name":"Copilot Chat Cookbook","href":"/en/copilot/tutorials/copilot-chat-cookbook","external":false},{"id":"copilot/how-tos/use-copilot-agents/coding-agent","name":"Coding agent","href":"/en/copilot/how-tos/use-copilot-agents/coding-agent","external":false},{"id":"copilot/how-tos/configure-custom-instructions","name":"Configure custom instructions","href":"/en/copilot/how-tos/configure-custom-instructions","external":false}]},{"name":"CI/CD and DevOps","icon":null,"octicon":"GearIcon","children":[{"id":"actions","name":"GitHub Actions","href":"/en/actions","external":false},{"id":"packages","name":"GitHub Packages","href":"/en/packages","external":false},{"id":"pages","name":"GitHub Pages","href":"/en/pages","external":false}]},{"name":"Security","icon":null,"octicon":"ShieldLockIcon","children":[{"id":"code-security","name":"Secure coding","href":"/en/code-security","external":false},{"id":"code-security/secret-scanning","name":"Secret scanning","href":"/en/code-security/secret-scanning","external":false},{"id":"code-security/supply-chain-security","name":"Supply chain security","href":"/en/code-security/supply-chain-security","external":false},{"id":"code-security/dependabot","name":"Dependabot","href":"/en/code-security/dependabot","external":false},{"id":"code-security/code-scanning","name":"Code scanning","href":"/en/code-security/code-scanning","external":false},{"id":"code-security/security-advisories","name":"Security advisories","href":"/en/code-security/security-advisories","external":false}]},{"name":"Client apps","icon":null,"octicon":"DeviceMobileIcon","children":[{"id":"github-cli","name":"GitHub CLI","href":"/en/github-cli","external":false},{"id":"get-started/using-github/github-mobile","name":"GitHub Mobile","href":"/en/get-started/using-github/github-mobile","external":false},{"id":"desktop","name":"GitHub Desktop","href":"/en/desktop","external":false}]},{"name":"Project management","icon":null,"octicon":"ProjectIcon","children":[{"id":"issues","name":"GitHub Issues","href":"/en/issues","external":false},{"id":"issues/planning-and-tracking-with-projects","name":"Projects","href":"/en/issues/planning-and-tracking-with-projects","external":false},{"id":"search-github","name":"Search on GitHub","href":"/en/search-github","external":false}]},{"name":"Enterprise and Teams","icon":null,"octicon":"OrganizationIcon","children":[{"id":"organizations","name":"Organizations","href":"/en/organizations","external":false},{"id":"code-security/securing-your-organization","name":"Secure your organization","href":"/en/code-security/securing-your-organization","external":false},{"id":"enterprise-onboarding","name":"Enterprise onboarding","href":"/en/enterprise-cloud@latest/enterprise-onboarding","external":false},{"id":"admin","name":"Enterprise administrators","href":"/en/enterprise-cloud@latest/admin","external":false},{"id":"gh-wa","name":"GitHub Well-Architected","href":"https://wellarchitected.github.com/","external":true}]},{"name":"Developers","icon":null,"octicon":"CodeSquareIcon","children":[{"id":"apps","name":"Apps","href":"/en/apps","external":false},{"id":"rest","name":"REST API","href":"/en/rest","external":false},{"id":"graphql","name":"GraphQL API","href":"/en/graphql","external":false},{"id":"webhooks","name":"Webhooks","href":"/en/webhooks","external":false},{"id":"copilot/how-tos/use-copilot-extensions","name":"Use Copilot Extensions","href":"/en/copilot/how-tos/use-copilot-extensions","external":false},{"id":"github-models","name":"GitHub Models","href":"/en/github-models","external":false}]},{"name":"Community","icon":null,"octicon":"GlobeIcon","children":[{"id":"communities","name":"Building communities","href":"/en/communities","external":false},{"id":"sponsors","name":"GitHub Sponsors","href":"/en/sponsors","external":false},{"id":"education","name":"GitHub Education","href":"/en/education","external":false},{"id":"nonprofit","name":"GitHub for Nonprofits","href":"/en/nonprofit","external":false},{"id":"support","name":"GitHub Support","href":"/en/support","external":false},{"id":"contributing","name":"Contribute to GitHub Docs","href":"/en/contributing","external":false}]},{"name":"More docs","icon":null,"octicon":"PencilIcon","children":[{"id":"codeql","name":"CodeQL query writing","href":"https://codeql.github.com/docs","external":true},{"id":"electron","name":"Electron","href":"https://electronjs.org/docs/latest","external":true},{"id":"npm","name":"npm","href":"https://docs.npmjs.com/","external":true},{"id":"gh-wa","name":"GitHub Well-Architected","href":"https://wellarchitected.github.com/","external":true}]}],"gettingStartedLinks":[{"title":"Set up Git","href":"/en/get-started/git-basics/set-up-git","intro":"At the heart of GitHub is an open-source version control system (VCS) called Git. Git is responsible for everything GitHub-related that happens locally on your computer."},{"title":"Connecting to GitHub with SSH","href":"/en/authentication/connecting-to-github-with-ssh","intro":"You can connect to GitHub using the Secure Shell Protocol (SSH), which provides a secure channel over an unsecured network."},{"title":"Creating and managing repositories","href":"/en/repositories/creating-and-managing-repositories","intro":"You can create a repository on GitHub to store and collaborate on your project's files, then manage the repository's name and location."},{"title":"Basic writing and formatting syntax","href":"/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax","intro":"Create sophisticated formatting for your prose and code on GitHub with simple syntax."}],"popularLinks":[{"title":"About pull requests","href":"/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests","intro":"Learn about pull requests and draft pull requests on GitHub. Pull requests communicate changes to a branch in a repository. Once a pull request is opened, you can review changes with collaborators and add follow-up commits."},{"title":"Authentication documentation","href":"/en/authentication","intro":"Keep your account and data secure with features like two-factor authentication, SSH, and commit signature verification."},{"title":"Getting code suggestions in your IDE with GitHub Copilot","href":"/en/copilot/how-tos/get-code-suggestions/get-code-suggestions","intro":"Use GitHub Copilot to get code suggestions in your editor."},{"title":"Managing remote repositories","href":"/en/get-started/git-basics/managing-remote-repositories","intro":"Learn to work with your local repositories on your computer and remote repositories hosted on GitHub."}]},"languagesContext":{"languages":{"en":{"name":"English","code":"en"},"es":{"name":"Spanish","code":"es","nativeName":"Español"},"ja":{"name":"Japanese","code":"ja","nativeName":"日本語"},"pt":{"name":"Portuguese","code":"pt","nativeName":"Português do Brasil"},"zh":{"name":"Simplified Chinese","code":"zh","hreflang":"zh-Hans","nativeName":"简体中文"},"ru":{"name":"Russian","code":"ru","nativeName":"Русский"},"fr":{"name":"French","code":"fr","nativeName":"Français"},"ko":{"name":"Korean","code":"ko","nativeName":"한국어"},"de":{"name":"German","code":"de","nativeName":"Deutsch"}}},"__N_SSP":true},"page":"/","query":{},"buildId":"BULiMFW5CTuwh8KGgW6Ed","isFallback":false,"isExperimentalCompile":false,"gssp":true,"appGip":true,"locale":"en","locales":["en","es","ja","pt","zh","ru","fr","ko","de"],"defaultLocale":"en","scriptLoader":[]}