diff --git a/content/admin/managing-iam/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts.md b/content/admin/managing-iam/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts.md index 4fcf71d54449..5bc0338025b3 100644 --- a/content/admin/managing-iam/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts.md +++ b/content/admin/managing-iam/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts.md @@ -45,7 +45,7 @@ With {% data variables.product.prodname_emus %}, you can control the user accoun ## {% data variables.product.prodname_copilot %} -* {% data variables.enterprise.prodname_managed_users_caps %} cannot sign up for {% data variables.copilot.copilot_pro %} or {% data variables.copilot.copilot_free %}. To allow a managed user to use {% data variables.product.prodname_copilot_short %}, you must grant the user access to a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} subscription. See [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +* {% data variables.enterprise.prodname_managed_users_caps %} cannot sign up for {% data variables.copilot.copilot_pro %} or {% data variables.copilot.copilot_free %}. To allow a managed user to use {% data variables.product.prodname_copilot_short %}, you must grant the user access to a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} subscription. See [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). * {% data reusables.copilot.cloud-agent-emu-limitation %} ## {% data variables.product.prodname_pages %} diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md index 97ff914757d4..6412292ff8b9 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md @@ -34,7 +34,7 @@ The events listed in your security log are triggered by your actions. Actions ar | {% ifversion fpt or ghec %} | | `billing` | Contains all activities related to your billing information. | | `codespaces` | Contains all activities related to {% data variables.product.prodname_github_codespaces %}. For more information, see [AUTOTITLE](/codespaces/quickstart). | -| `copilot` | Contains all activities related to {% data variables.copilot.copilot_business_short %}. For more information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot). | +| `copilot` | Contains all activities related to {% data variables.copilot.copilot_business_short %}. For more information, see [AUTOTITLE](/copilot/get-started/about-github-copilot). | | `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. | | `marketplace_listing`| Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}. | | {% endif %} | diff --git a/content/billing/concepts/budgets-and-alerts.md b/content/billing/concepts/budgets-and-alerts.md index 0f2210296cd0..26c858bc09ed 100644 --- a/content/billing/concepts/budgets-and-alerts.md +++ b/content/billing/concepts/budgets-and-alerts.md @@ -30,7 +30,7 @@ Each budget has a type and a scope that define which paid use contributes to spe * **Cost center user-level**: applies to every user in a cost center * **Individual**: overrides the above for specific users, and can be given an optional expiration date so a temporary override is removed automatically -For {% data variables.product.prodname_copilot_short %}, cost centers can also have included usage controls, which cap how much of the shared {% data variables.product.prodname_ai_credits_short %} pool a cost center can use before metered usage begins. This is a separate control from the budgets and the included usage alerts described below. See [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing#included-usage-controls-for-cost-centers). +For {% data variables.product.prodname_copilot_short %}, cost centers can also have included usage controls, which cap how much of the shared {% data variables.product.prodname_ai_credits_short %} pool a cost center can use before metered usage begins. This is a separate control from the budgets and the included usage alerts described below. See [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets#included-usage-controls-for-cost-centers). ## Roles and access for budgets diff --git a/content/billing/concepts/cost-centers.md b/content/billing/concepts/cost-centers.md index 356989fe8146..087432b189e8 100644 --- a/content/billing/concepts/cost-centers.md +++ b/content/billing/concepts/cost-centers.md @@ -35,7 +35,7 @@ For cost centers that contain {% data variables.product.prodname_copilot_short % {% data reusables.billing.included-usage-controls %} -This is separate from a cost center budget, which caps metered charges only after the shared pool of {% data variables.product.prodname_ai_credits_short %} is exhausted. For more information, see [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing#included-usage-controls-for-cost-centers). +This is separate from a cost center budget, which caps metered charges only after the shared pool of {% data variables.product.prodname_ai_credits_short %} is exhausted. For more information, see [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets#included-usage-controls-for-cost-centers). ## Cost center limitations diff --git a/content/billing/concepts/product-billing/github-code-quality.md b/content/billing/concepts/product-billing/github-code-quality.md index 9441ea76e11a..82e44a153d25 100644 --- a/content/billing/concepts/product-billing/github-code-quality.md +++ b/content/billing/concepts/product-billing/github-code-quality.md @@ -30,7 +30,7 @@ In a detailed usage report, you can identify usage from {% data variables.produc {% data reusables.code-quality.model-usage %} -For more information about how {% data variables.product.prodname_ai_credits_short %} work, see [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises/usage-based-billing). +For more information about how {% data variables.product.prodname_ai_credits_short %} work, see [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/billing). ### Active and unique committers @@ -42,7 +42,7 @@ For more information about how {% data variables.product.prodname_ai_credits_sho To understand your license usage, and which licenses you can free up, it helps to distinguish between active and unique committers. You can see the number of licenses you're using on the **Licensing** page for your organization or enterprise, shown as **"Consumed licenses"**: * **Active committers** are committers who contributed to at least one repository and have a {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} license with your organization or enterprise. This includes members, enterprise-managed users, external collaborators, and people with a pending invitation to join your organization or enterprise. -* **Unique committers** is the number of active committers who contributed only to one repository, or only to repositories in one organization. You can free up this number of licenses by disabling {% data variables.product.prodname_code_quality_short %} for that repository or organization. +* **Unique committers** is the number of active committers who contributed only to one repository, or only to repositories in one organization. You can free these licenses for the next billing period by disabling {% data variables.product.prodname_code_quality_short %} for that repository or organization. This doesn't reduce your license charge for the current period. Users can contribute to multiple repositories or organizations. Usage is measured across the whole organization or enterprise to ensure that each member uses one license regardless of how many repositories or organizations the user contributes to. @@ -50,4 +50,4 @@ Users can contribute to multiple repositories or organizations. Usage is measure * [AUTOTITLE](/code-security/tutorials/improve-code-quality/catch-issues-before-merge) * [AUTOTITLE](/billing/concepts/product-billing/github-actions) -* [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises/usage-based-billing) +* [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/billing) diff --git a/content/billing/concepts/product-billing/github-copilot-billing.md b/content/billing/concepts/product-billing/github-copilot-billing.md index 272a1361467a..11c9acd17997 100644 --- a/content/billing/concepts/product-billing/github-copilot-billing.md +++ b/content/billing/concepts/product-billing/github-copilot-billing.md @@ -14,12 +14,12 @@ category: All individual plans—{% data variables.copilot.copilot_free_short %}, {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, and {% data variables.copilot.copilot_max_short %}—include a monthly {% data variables.product.prodname_ai_credits %} allowance that varies by plan. -To understand how {% data variables.product.prodname_ai_credits_short %} work for individual plans, see [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-individuals). +To understand how {% data variables.product.prodname_ai_credits_short %} work for individual plans, see [AUTOTITLE](/copilot/concepts/billing-and-usage/individuals/billing). ## Organizations and enterprises For organizations and enterprises, each assigned {% data variables.product.prodname_copilot_short %} license comes with a monthly amount of included {% data variables.product.prodname_ai_credits_short %}, which can be pooled at the billing entity level. -* To understand how {% data variables.product.prodname_ai_credits_short %} work and what happens when your pool is exhausted, see [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises/usage-based-billing). -* To understand budget controls and how to prevent unexpected charges, see [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing). +* To understand how {% data variables.product.prodname_ai_credits_short %} work and what happens when your pool is exhausted, see [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/billing). +* To understand budget controls and how to prevent unexpected charges, see [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets). * To compare per-token costs across models and how they translate to {% data variables.product.prodname_ai_credits_short %}, see [AUTOTITLE](/copilot/reference/copilot-billing/models-and-pricing). diff --git a/content/billing/concepts/product-billing/github-copilot-licenses.md b/content/billing/concepts/product-billing/github-copilot-licenses.md index 1d848611af4c..6bac3655ab1b 100644 --- a/content/billing/concepts/product-billing/github-copilot-licenses.md +++ b/content/billing/concepts/product-billing/github-copilot-licenses.md @@ -15,7 +15,7 @@ category: - Understand product costs --- -Usage of {% data variables.product.prodname_copilot %} is measured through a combination of licenses and {% data variables.product.prodname_ai_credits_short %}. See [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-individuals) and [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises/usage-based-billing). +Usage of {% data variables.product.prodname_copilot %} is measured through a combination of licenses and {% data variables.product.prodname_ai_credits_short %}. See [AUTOTITLE](/copilot/concepts/billing-and-usage/individuals/billing) and [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/billing). ## Licenses for {% data variables.product.prodname_copilot_short %} @@ -55,7 +55,7 @@ Usage of {% data variables.product.prodname_copilot_short %} licenses is measure * Downgrades take effect at the start of the next billing cycle and are generally not prorated. * Canceling a monthly plan keeps access until the end of the current billing cycle, with no proration. -For details on billing and proration, see [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-individuals). +For details on billing and proration, see [AUTOTITLE](/copilot/concepts/billing-and-usage/individuals/billing). ### Organizations and enterprises diff --git a/content/billing/how-tos/products/view-productlicense-use.md b/content/billing/how-tos/products/view-productlicense-use.md index 2e362dd63311..6f49e7d98bc3 100644 --- a/content/billing/how-tos/products/view-productlicense-use.md +++ b/content/billing/how-tos/products/view-productlicense-use.md @@ -101,7 +101,7 @@ If you use {% data variables.product.prodname_copilot_short %}, an additional ** * Which models are driving the most spend? * How widespread is adoption in the organizations where we rolled out {% data variables.product.prodname_copilot_short %}? -To understand how {% data variables.product.prodname_ai_credits_short %} are pooled across your enterprise and what the usage data represents, see [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises/usage-based-billing). +To understand how {% data variables.product.prodname_ai_credits_short %} are pooled across your enterprise and what the usage data represents, see [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/billing). {% endif %} diff --git a/content/billing/how-tos/set-up-budgets.md b/content/billing/how-tos/set-up-budgets.md index 721fab220bc3..9cd45a7f855a 100644 --- a/content/billing/how-tos/set-up-budgets.md +++ b/content/billing/how-tos/set-up-budgets.md @@ -39,7 +39,7 @@ In this example, the organization has set a budget of $50 for the "Actions" prod We recommend that you avoid creating overlapping budgets for the use of a product and a SKU, or an organization and a repository, so that users are not unexpectedly blocked from using a feature that they rely on. Alternatively, you may prefer to monitor use without blocking users by disabling the "Stop usage when budget limit is reached" option. -For {% data variables.product.prodname_copilot_short %} under usage-based billing, user-level budgets add another layer to consider. A user-level budget can block a user even when the enterprise or cost center budget still has capacity. It is the first check in the evaluation sequence. When planning your budget configuration, account for how user-level budgets, cost center budgets, and the enterprise spending limit interact. See [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing#how-billing-flows-through-budgets). +For {% data variables.product.prodname_copilot_short %} under usage-based billing, user-level budgets add another layer to consider. A user-level budget can block a user even when the enterprise or cost center budget still has capacity. It is the first check in the evaluation sequence. When planning your budget configuration, account for how user-level budgets, cost center budgets, and the enterprise spending limit interact. See [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets#how-billing-flows-through-budgets). ## Managing budgets for your personal account @@ -79,7 +79,7 @@ To edit or delete a budget, on the "Budget and alerts" page, click **Edit** or * ## Managing budgets for your organization or enterprise > [!IMPORTANT] -> {% data variables.product.prodname_copilot_short %} usage is now measured in {% data variables.product.prodname_ai_credits_short %} under usage-based billing. Existing premium request budgets have been automatically converted to {% data variables.product.prodname_ai_credit_singular %} budgets. See [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises/usage-based-billing). +> {% data variables.product.prodname_copilot_short %} usage is now measured in {% data variables.product.prodname_ai_credits_short %} under usage-based billing. Existing premium request budgets have been automatically converted to {% data variables.product.prodname_ai_credit_singular %} budgets. See [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/billing). You can set budgets and receive alerts when your usage of a product or license type reaches 75%, 90%, or 100% of a defined budget. For budgets that control metered use of a product, you can also block further use when the budget is exhausted. Each budget has a scope. @@ -126,7 +126,7 @@ As the owner of an enterprise or organization account, or as a billing manager, * **End of current billing cycle**: {% data variables.product.github %} removes the budget when the current billing cycle ends. * **Specific date**: {% data variables.product.github %} removes the budget on the date you choose. - When an individual budget expires, {% data variables.product.github %} removes it and the user falls back to the next budget that applies to them: their cost center user-level budget, if they have one, or otherwise the universal user-level budget. If neither budget is configured, no user-level budget applies. See [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing#expiration-dates-for-individual-user-level-budgets). + When an individual budget expires, {% data variables.product.github %} removes it and the user falls back to the next budget that applies to them: their cost center user-level budget, if they have one, or otherwise the universal user-level budget. If neither budget is configured, no user-level budget applies. See [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets#expiration-dates-for-individual-user-level-budgets). 1. Under "Budget", set a budget amount or license count. @@ -161,9 +161,9 @@ For an individual user-level budget, you can also change or clear the expiration ### Controlling included usage for a cost center -Budgets cap metered charges after the shared pool of {% data variables.product.prodname_ai_credits_short %} is exhausted. To cap how much of the pool a cost center can use **before** the metered phase, use an included usage control. {% data variables.product.github %} sets the cap automatically based on the licenses assigned to the cost center, and you choose whether members are blocked or roll into paid overage when the cap is reached. See [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing#included-usage-controls-for-cost-centers) and [AUTOTITLE](/billing/concepts/cost-centers). +Budgets cap metered charges after the shared pool of {% data variables.product.prodname_ai_credits_short %} is exhausted. To cap how much of the pool a cost center can use **before** the metered phase, use an included usage control. {% data variables.product.github %} sets the cap automatically based on the licenses assigned to the cost center, and you choose whether members are blocked or roll into paid overage when the cap is reached. See [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets#included-usage-controls-for-cost-centers) and [AUTOTITLE](/billing/concepts/cost-centers). > [!NOTE] > Enabling included usage controls does not retroactively redistribute the shared {% data variables.product.prodname_ai_credits_short %} enterprise pool. After the setting is enabled, users in the cost center share only the included {% data variables.product.prodname_ai_credits_short %} funded by licenses attributed to that cost center. When the setting is disabled, users in the cost center can continue drawing from the shared enterprise pool. ## Next steps -For {% data variables.product.prodname_copilot_short %}-specific budget guidance under usage-based billing, including user-level budgets and configuration scenarios, see [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing) and [AUTOTITLE](/copilot/tutorials/budgets/optimizing-your-budget-configuration). +For {% data variables.product.prodname_copilot_short %}-specific budget guidance under usage-based billing, including user-level budgets and configuration scenarios, see [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets) and [AUTOTITLE](/copilot/tutorials/budgets/optimizing-your-budget-configuration). diff --git a/content/billing/reference/cost-center-allocation.md b/content/billing/reference/cost-center-allocation.md index 169ec2d9f405..76a03fb481b5 100644 --- a/content/billing/reference/cost-center-allocation.md +++ b/content/billing/reference/cost-center-allocation.md @@ -48,7 +48,7 @@ Users who belong to multiple organizations in an enterprise or who receive a {% To confirm which organization is charged for a given user's license, you can request a detailed usage report. See [AUTOTITLE](/billing/reference/billing-reports#detailed-usage-report). -See [AUTOTITLE](/copilot/concepts/billing/organizations-and-enterprises#seat-assignment). +See [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/seats-and-billing-cycles#seat-assignment). ## Understanding cost center usage and attribution diff --git a/content/billing/tutorials/control-costs-at-scale.md b/content/billing/tutorials/control-costs-at-scale.md index 0110a8e6e851..6079bf834c20 100644 --- a/content/billing/tutorials/control-costs-at-scale.md +++ b/content/billing/tutorials/control-costs-at-scale.md @@ -21,7 +21,7 @@ This tutorial guides you through planning, creating, and managing cost centers u As your enterprise grows, you can layer increasingly granular controls on top of cost centers to keep {% data variables.product.prodname_copilot_short %} spending predictable: * **Group at scale.** Assign whole enterprise teams to a cost center so membership stays current automatically as people join and leave. -* **Cap per-user spending.** Set a cost center user-level budget so every member of a cost center inherits the same per-person limit. See [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing). +* **Cap per-user spending.** Set a cost center user-level budget so every member of a cost center inherits the same per-person limit. See [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets). ## 1. Plan your cost center strategy @@ -125,7 +125,7 @@ Filter the other budgets list to show a scope of **Cost Centers**. You should se Keep these limits in mind as you combine budgets across scopes: -* **Budgets overlap, and the most restrictive one applies.** A user can be covered by an individual, cost center, organization, and enterprise budget at the same time. Whichever has the least headroom remaining blocks them first. If someone is blocked unexpectedly, review every scope that applies to them. For the full evaluation order, see [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing). +* **Budgets overlap, and the most restrictive one applies.** A user can be covered by an individual, cost center, organization, and enterprise budget at the same time. Whichever has the least headroom remaining blocks them first. If someone is blocked unexpectedly, review every scope that applies to them. For the full evaluation order, see [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets). * **You can't set different budgets for teams in the same cost center.** A budget applies to the whole cost center, not to teams within it. If two teams need separate budgets, create a separate cost center for each. Separate cost centers can still share the same Azure billing identity. * **Budgets don't add up across levels.** An enterprise budget isn't the sum of your cost center budgets, and raising one doesn't raise another. When you change a budget at one level, reconcile the totals at the others yourself. @@ -325,5 +325,5 @@ If there are any paid products that you want to block all access to, you can dis To go deeper on the controls in this tutorial: -* For how cost center budgets and user-level budgets interact across the pool and metered phases, see [AUTOTITLE](/copilot/concepts/billing/budgets-for-usage-based-billing). +* For how cost center budgets and user-level budgets interact across the pool and metered phases, see [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/budgets). * For how resources are allocated to cost centers, including enterprise team membership, see [AUTOTITLE](/billing/reference/cost-center-allocation). diff --git a/content/code-security/how-tos/maintain-quality-code/disable-code-quality.md b/content/code-security/how-tos/maintain-quality-code/disable-code-quality.md index 03459a499ff3..a7737cdceecc 100644 --- a/content/code-security/how-tos/maintain-quality-code/disable-code-quality.md +++ b/content/code-security/how-tos/maintain-quality-code/disable-code-quality.md @@ -20,7 +20,7 @@ category: 1. In the sidebar, under **{% data variables.product.prodname_security_and_quality_tab %}**, click **{% data variables.code-quality.code_quality_ui_settings %}** to display the "{% data variables.code-quality.code_quality_ui %}" page. 1. Under **{% data variables.product.prodname_code_quality_short %} analysis**, toggle from **On** to **Off**. -This stops all future {% data variables.product.prodname_code_quality_short %} scans, and the billing they generate, for that repository. +This stops all future {% data variables.product.prodname_code_quality_short %} scans for that repository, along with the {% data variables.product.prodname_actions %} minutes and {% data variables.product.prodname_ai_credits_short %} those scans use. License charges continue for a period after you disable {% data variables.product.prodname_code_quality_short %}. See [When billing stops](#when-billing-stops). ## Disabling {% data variables.product.prodname_code_quality_short %} for an organization @@ -33,6 +33,8 @@ Disabling at the organization level turns {% data variables.product.prodname_cod 1. To also disable {% data variables.product.prodname_code_quality_short %} in repositories where an administrator has deliberately enabled it, and to prevent administrators from re-enabling it, turn on **Enforce access**. Without enforcement, those repositories keep {% data variables.product.prodname_code_quality_short %} enabled. 1. Unless you select **Let repositories decide**, a "Review enablement and billing changes" dialog appears, showing the total number of affected repositories. Review the details, then click **Confirm**. +For repositories affected by the organization-level change, disabling stops future scans and the metered usage they generate. Repositories that are explicitly enabled continue scanning unless you turn on **Enforce access**. License charges continue for a period after the change. See [When billing stops](#when-billing-stops). + For the full list of access options and how enforcement works, see [AUTOTITLE](/code-security/concepts/code-quality/enablement-at-scale#organization-level-repository-access). ## What happens to your existing data @@ -44,9 +46,24 @@ Disabling {% data variables.product.prodname_code_quality_short %}: ## When billing stops -Disabling stops new scans right away, so no further {% data variables.product.prodname_actions %} minutes or {% data variables.product.prodname_ai_credits_short %} are consumed. +Disabling {% data variables.product.prodname_code_quality_short %} stops metered usage immediately, but license charges continue for a period afterwards. For an overview of what {% data variables.product.prodname_code_quality_short %} bills for, see [AUTOTITLE](/billing/concepts/product-billing/github-code-quality). + +### Metered usage stops immediately + +Disabling stops new scans right away, so you use no further {% data variables.product.prodname_actions %} minutes or {% data variables.product.prodname_ai_credits_short %}. + +Usage from before you disabled still bills as normal. Metered usage adds up over the course of the month and appears on your next bill. + +### License charges can continue + +Disabling {% data variables.product.prodname_code_quality_short %} can reduce the number of licenses you use: + +* A committer who contributed only to repositories where you disable {% data variables.product.prodname_code_quality_short %} no longer counts towards your license usage. +* A committer who also contributed to another repository where {% data variables.product.prodname_code_quality_short %} remains enabled continues to count. They stop counting 90 days after their most recent commit to an enabled repository. + +For each billing period, you're charged for the highest number of licenses used at any point during that period, not the number in use at the end. Disabling {% data variables.product.prodname_code_quality_short %} can free licenses for the next period, but it doesn't reduce the charge for the current period. -Usage you've already accrued this cycle still bills as normal. All metered usage adds up over the course of the month and bills on your next billing cycle date, so your next bill will show the {% data variables.product.prodname_ai_credits_short %} usage and licenses consumed before you disabled the feature. You won't see new charges accrue after the disable date. +{% data variables.product.prodname_code_quality_short %} uses the same licensing model as {% data variables.product.prodname_GHAS %}. To see how the active committer count changes as people stop committing and as repositories are enabled and disabled, see [AUTOTITLE](/billing/concepts/product-billing/github-advanced-security#example-showing-how-the-active-committer-count-changes-over-time). ## Confirming {% data variables.product.prodname_code_quality_short %} is off diff --git a/content/code-security/how-tos/maintain-quality-code/view-and-manage-cost.md b/content/code-security/how-tos/maintain-quality-code/view-and-manage-cost.md index 1450bddd51b7..985bd3f2a042 100644 --- a/content/code-security/how-tos/maintain-quality-code/view-and-manage-cost.md +++ b/content/code-security/how-tos/maintain-quality-code/view-and-manage-cost.md @@ -51,7 +51,7 @@ Once {% data variables.product.prodname_code_quality_short %} is running, watch You have several levers to keep spend in check. In rough order of impact: * **Enable selectively.** Turn {% data variables.product.prodname_code_quality_short %} on where it adds value rather than across every repository at once. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/enable-code-quality). -* **Disable low-value repositories.** Disabling {% data variables.product.prodname_code_quality_short %} on a repository frees the licenses for committers unique to it, and stops its scans and AI usage. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/disable-code-quality). +* **Disable low-value repositories.** Disabling {% data variables.product.prodname_code_quality_short %} on a repository stops its scans and AI usage immediately. It can free licenses for committers unique to that repository for the next billing period, but it doesn't reduce the charge for the current period. See [AUTOTITLE](/code-security/how-tos/maintain-quality-code/disable-code-quality). * **Set a budget.** A budget for {% data variables.product.prodname_code_quality_short %} stops your spending automatically once you hit your limit, because the hard stop is mandatory (see below). * **Keep the {% data variables.code-quality.recent_suggestions %} page off.** This page is **off by default** and stays in {% data variables.release-phases.public_preview %}, so it only draws down {% data variables.product.prodname_ai_credits_short %} if you turn it on. Repositories that enabled it during the preview keep it on. To turn it off for a repository, disable **{% data variables.code-quality.recent_suggestions %}** on the repository's **{% data variables.code-quality.code_quality_ui %}** settings page. diff --git a/content/codespaces/reference/using-github-copilot-in-github-codespaces.md b/content/codespaces/reference/using-github-copilot-in-github-codespaces.md index f16f89c63f8f..ef263ee8c378 100644 --- a/content/codespaces/reference/using-github-copilot-in-github-codespaces.md +++ b/content/codespaces/reference/using-github-copilot-in-github-codespaces.md @@ -14,7 +14,7 @@ category: - Write code in a codespace --- -[{% data variables.product.prodname_copilot %}](https://copilot.github.com/) is an AI pair programmer that you can use in any codespace that you open in the {% data variables.product.prodname_vscode_shortname %} web client or desktop application. For more information about {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot). +[{% data variables.product.prodname_copilot %}](https://copilot.github.com/) is an AI pair programmer that you can use in any codespace that you open in the {% data variables.product.prodname_vscode_shortname %} web client or desktop application. For more information about {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/get-started/about-github-copilot). To start using {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_github_codespaces %}, install the [{% data variables.product.prodname_copilot %} extension from the {% data variables.product.prodname_vscode_marketplace %}](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). @@ -22,4 +22,5 @@ To include {% data variables.product.prodname_copilot %}, or other extensions, i ## Further reading -* [AUTOTITLE](/copilot/get-started/quickstart) +* [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-on-github-com) +* [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide) diff --git a/content/copilot/concepts/agents/copilot-cli/fleet.md b/content/copilot/concepts/agents/copilot-cli/fleet.md index 1b751d0de58e..ed0f11065ef3 100644 --- a/content/copilot/concepts/agents/copilot-cli/fleet.md +++ b/content/copilot/concepts/agents/copilot-cli/fleet.md @@ -17,7 +17,11 @@ docsTeamMetrics: The `/fleet` slash command in {% data variables.copilot.copilot_cli_short %} is designed to take an implementation plan and break it down into smaller, independent tasks that can be executed in parallel by subagents. This allows for faster completion of complex requests that involve multiple steps. -This article gives an overview of the `/fleet` slash command. For details of how to use it, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion). +This article gives a conceptual overview of the `/fleet` slash command. + +You can also start fleet mode directly from the command line by using the `--fleet` option. This is the command-line equivalent of the `/fleet` slash command. + +For information on using the `/fleet` slash command, and the `--fleet` command line option, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion). ## How `/fleet` works diff --git a/content/copilot/concepts/enterprise/learning-about-new-features-and-models.md b/content/copilot/concepts/enterprise/learning-about-new-features-and-models.md index 8429e9d02766..5764c1f24522 100644 --- a/content/copilot/concepts/enterprise/learning-about-new-features-and-models.md +++ b/content/copilot/concepts/enterprise/learning-about-new-features-and-models.md @@ -24,10 +24,10 @@ You can use {% data variables.product.prodname_docs %} and {% data variables.pro To learn about new {% data variables.product.prodname_copilot_short %} features, we recommend monitoring these two locations: -* **Features overview**: For a complete list of {% data variables.product.prodname_copilot_short %} capabilities, see [AUTOTITLE](/copilot/get-started/features). -* **Changelog**: Follow the [{% data variables.product.prodname_copilot_short %} changelog](https://github.blog/changelog/label/copilot/) for announcements about new and updated features. +* **Copilot blog updates**: For broader news and updates about {% data variables.product.prodname_copilot_short %}, see the [{% data variables.product.prodname_copilot_short %} blog](https://github.blog/ai-and-ml/github-copilot/). +* **Changelog**: For announcements about newly released and updated features, follow the [{% data variables.product.prodname_copilot_short %} changelog](https://github.blog/changelog/?label=copilot). -{% data variables.product.prodname_copilot_short %} features generally fall into three categories: +{% data variables.product.prodname_copilot_short %}'s capabilities and supporting features fall into four categories: {% rowheaders %} @@ -35,7 +35,8 @@ To learn about new {% data variables.product.prodname_copilot_short %} features, | --- | --- | --- | --- | | Assistive | Respond to prompts and provide suggestions, but require human review before changes are made. | Inline suggestions, {% data variables.copilot.copilot_chat_short %}, {% data variables.copilot.copilot_for_prs %}. | All changes require user approval. | | Agentic | Autonomously research, plan, and make changes on behalf of users. | {% data variables.copilot.copilot_cloud_agent %}, third-party agents. | Can work autonomously, but with built-in protections. | -| Third-party | External coding agents that work alongside {% data variables.copilot.copilot_cloud_agent %} to complete tasks asynchronously. | {% data variables.product.prodname_anthropic_claude %}, {% data variables.product.prodname_openai_codex %}. | Same as agentic. Review provider documentation and enable via policies. See [AUTOTITLE](/copilot/concepts/agents/about-third-party-coding-agents). | +| Customizations | Add context, instructions, tools, skills, and agents to tailor how {% data variables.product.prodname_copilot_short %} responds and works. | Custom instructions, prompt files, {% data variables.copilot.copilot_spaces %}, MCP servers, agent skills, custom agents. | Support and configuration vary by feature and surface. Organization and enterprise policies can control access to some customizations. | +| External AI agents, models, and tools | External coding agents, models, and tools, including MCP servers from other providers, that work alongside {% data variables.copilot.copilot_cloud_agent %} to complete tasks asynchronously. | {% data variables.product.prodname_anthropic_claude %}, {% data variables.product.prodname_openai_codex %}. | Same as agentic. Review provider documentation and enable via policies. See [AUTOTITLE](/copilot/concepts/agents/about-third-party-coding-agents). | {% endrowheaders %} diff --git a/content/copilot/get-started/about-github-copilot.md b/content/copilot/get-started/about-github-copilot.md new file mode 100644 index 000000000000..dd27118d5720 --- /dev/null +++ b/content/copilot/get-started/about-github-copilot.md @@ -0,0 +1,104 @@ +--- +title: About GitHub Copilot +shortTitle: About Copilot +intro: 'Understand how {% data variables.product.prodname_copilot %} helps you ship software faster, how it works, and how to get access.' +versions: + feature: copilot +redirect_from: + - /copilot/copilot-individual + - /copilot/copilot-individual/about-github-copilot-individual + - /copilot/copilot-business/about-github-copilot-business + - /copilot/github-copilot-enterprise/about-github-copilot-enterprise + - /copilot/github-copilot-enterprise/overview + - /copilot/overview-of-github-copilot/about-github-copilot-for-individuals + - /copilot/overview-of-github-copilot/about-github-copilot + - /copilot/overview-of-github-copilot/about-github-copilot-individual + - /copilot/overview-of-github-copilot/about-github-copilot-for-business + - /copilot/overview-of-github-copilot/about-github-copilot-business + - /copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise + - /copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization + - /copilot/managing-copilot-business + - /copilot/managing-copilot-for-business + - /copilot/github-copilot-enterprise + - /copilot/copilot-business + - /copilot/copilot-business/github-copilot-business-feature-set + - /copilot/copilot-individual/github-copilot-individual-feature-set + - /copilot/github-copilot-enterprise/github-copilot-enterprise-feature-set + - /copilot/about-github-copilot/github-copilot-features + - /copilot/get-started/github-copilot-features + - /copilot/get-started/features + - /copilot/about-github-copilot/what-is-github-copilot + - /copilot/get-started/what-is-github-copilot +contentType: get-started +category: + - Learn about Copilot +--- + +{% data variables.product.prodname_copilot %} is an AI assistant that helps you write, understand, and ship software. It suggests code as you type, answers questions about a codebase, reviews your changes, and works on tasks you assign it. + +Because {% data variables.product.prodname_copilot_short %} is built into {% data variables.product.github %}, it works within the development workflow you already use: + +* Your code and its history. +* The issues and pull requests you already use to track work. +* The automations you run in your repository. + +A change can start as an issue, be picked up by an agent, return as a pull request, get reviewed for quality and security, and be merged. + +You and {% data variables.product.prodname_copilot_short %} work on it in the same place, with the same context, instead of moving code into separate tools and back again. + +## How {% data variables.product.prodname_copilot_short %} works + +{% data variables.product.prodname_copilot_short %}'s capabilities and supporting features fall into four categories: + +**Assistive.** {% data variables.product.prodname_copilot_short %} responds while you work, suggesting code, answering questions, or explaining code. You review and apply each suggestion. + +**Agentic.** You describe a goal, and {% data variables.product.prodname_copilot_short %} can work through multiple steps. It researches a repository, proposes a plan, edits files, reviews pull requests, runs tools, and prepares tasks for your review. You remain responsible for reviewing and approving. + +**Customizations.** You customize {% data variables.product.prodname_copilot_short %}'s responses with instructions, reusable prompts, repository context, external tools, agent skills, and custom agents. When {% data variables.product.prodname_copilot_short %} understands your project's structure, conventions, and tooling, it gives you better responses. + +**External AI agents, models, and tools.** Coding agents, models, and tools, including MCP servers from other providers, work alongside {% data variables.product.prodname_copilot_short %}. Third-party coding agents work asynchronously on development tasks and can make changes and open or update pull requests for your review. They are subject to the same security protections, mitigations, and limitations as {% data variables.product.prodname_copilot_short %}. + +## What you can do with {% data variables.product.prodname_copilot_short %} + +{% data variables.product.prodname_copilot_short %} helps you throughout the software development lifecycle. For example: + +* **Understand code** by asking questions about files, repositories, and development concepts. +* **Plan and implement tasks** with an agent that can research a repository, make changes, and prepare a pull request for your review. +* **Customize responses** with instructions, reusable prompts, repository context, tools, and specialized agents. +* **Write code** with inline suggestions and natural-language prompts. +* **Build applications** from natural-language descriptions. +* **Change code** by asking {% data variables.product.prodname_copilot_short %} to edit, refactor, or fix code. +* **Review code** and pull requests, including summaries and suggestions for potential improvements. + +The capabilities available to you depend on your Copilot plan, the client you use, and your organization's policies. + +## Get access + +You can start using {% data variables.product.prodname_copilot_short %} in several ways, depending on your role and needs. + +### Individuals + +* **Try {% data variables.product.prodname_copilot_short %} for free.** Use [{% data variables.copilot.copilot_free_short %}](https://github.com/copilot?ref_product=copilot&ref_plan=free&ref_style=text&ref_type=engagement) to explore core features with no paid plan required. +* **Subscribe to a paid plan.** Upgrade to a paid plan for access to premium features, increased access to models, and a higher monthly allowance of {% data variables.product.prodname_ai_credits_short %}. See [AUTOTITLE](/copilot/how-tos/manage-your-account/get-started-with-a-copilot-plan) for more information. +* **Get free access if you're eligible.** Students, teachers, and open source maintainers may qualify for access to premium features at no cost. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students) and [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-teachers-and-os-maintainers). + +### Members of an organization + +* **Request access from your organization.** If your organization or enterprise has a {% data variables.product.prodname_copilot %} plan, go to [https://github.com/settings/copilot](https://github.com/settings/copilot) and request access under "Get {% data variables.product.prodname_copilot_short %} from an organization." + +### Organization and enterprise owners + +{% data reusables.copilot.plans.subscribe-for-org %} + +{% data reusables.copilot.plans.subscribe-for-enterprise %} + +## Control for organizations and enterprises + +If you use {% data variables.product.prodname_copilot_short %} through an organization or enterprise, administrators decide how it can be used. They control which members have access, set policies for which features are available, exclude files that {% data variables.product.prodname_copilot_short %} shouldn't see, and review usage data and audit logs to understand how it's being used. + +These settings help administrators manage {% data variables.product.prodname_copilot_short %} across the environments and features available to their organization or enterprise. Some settings and controls depend on the {% data variables.product.prodname_copilot_short %} plan and the client where {% data variables.product.prodname_copilot_short %} is used. See [AUTOTITLE](/copilot/how-tos/administer-copilot). + +## Next steps + +* Start using {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/how-tos/set-up). +* View the {% data variables.product.prodname_copilot_short %} features available to you by navigating to your {% data variables.product.prodname_copilot_short %} settings at [https://github.com/settings/copilot/features](https://github.com/settings/copilot/features?ref_product=copilot&ref_type=engagement&ref_style=text). diff --git a/content/copilot/get-started/features.md b/content/copilot/get-started/features.md deleted file mode 100644 index 52ebe70e0aa0..000000000000 --- a/content/copilot/get-started/features.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: GitHub Copilot features -intro: '{% data variables.product.prodname_copilot %} offers a suite of features for users and administrators.' -versions: - feature: copilot -shortTitle: Features -redirect_from: - - /copilot/copilot-business/github-copilot-business-feature-set - - /copilot/copilot-individual/github-copilot-individual-feature-set - - /copilot/github-copilot-enterprise/github-copilot-enterprise-feature-set - - /copilot/about-github-copilot/github-copilot-features - - /copilot/get-started/github-copilot-features -contentType: get-started -category: - - Learn about Copilot ---- - -## Assistive features - -These tools are used synchronously, providing advice or suggestions as people work on a task. - -### {% data variables.copilot.copilot_chat_short %} - -A chat interface that lets you ask coding-related questions. {% data variables.copilot.copilot_chat %} is available on the {% data variables.product.github %} website, in {% data variables.product.prodname_mobile %}, in supported IDEs, and in {% data variables.product.prodname_windows_terminal %}. Users can also use skills with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github) and [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). - -### Inline suggestions - -Autocomplete-style suggestions from {% data variables.product.prodname_copilot_short %} in supported IDEs. See [AUTOTITLE](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions). - -If you use {% data variables.product.prodname_vscode_shortname %}, Xcode, or Eclipse, you can also use {% data variables.copilot.next_edit_suggestions %}, which will predict the location of the next edit you are likely to make and suggest a completion for it. - -### {% data variables.copilot.copilot_for_prs %} - -AI-generated summaries of the changes that were made in a pull request, which files they impact, and what a reviewer should focus on when they conduct their review. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/create-a-pr-summary). - -### {% data variables.copilot.copilot_desktop_short %} - -Automatically generate commit messages and descriptions with {% data variables.copilot.copilot_desktop_short %} based on the changes you make to your project. - -## Agentic features - -These features can work autonomously without direct human supervision. However, they typically need human approval to perform sensitive actions, such as running commands in a developer's terminal or merging a pull request. - -### {% data variables.copilot.copilot_cli_short %} - -A command line interface that lets you use {% data variables.product.prodname_copilot_short %} in your terminal. Use the CLI to add features or fix bugs, then create a pull request. Start {% data variables.product.prodname_copilot_short %} working on a task in your terminal, then continue working in the same session on {% data variables.product.prodname_dotcom_the_website %}, or on your mobile. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-copilot-cli). - -### {% data variables.copilot.github_copilot_app %} - -A desktop application for agent-driven development. From the app, you can run multiple agent sessions in parallel across your repositories, manage issues and pull requests, and set up automations to run tasks on a schedule. See [AUTOTITLE](/copilot/concepts/agents/github-copilot-app). - -### {% data variables.copilot.copilot_cloud_agent %} - -An autonomous AI agent that can research a repository, create an implementation plan, and make code changes on a branch. You can review the diff, iterate, and create a pull request when you're ready. You can also assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %} or ask it to open a pull request directly to complete a task. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent). - -### Third-party coding agents ({% data variables.release-phases.public_preview %}) - -You can use third-party coding agents alongside {% data variables.copilot.copilot_cloud_agent %}. Third-party agents are subject to the same security protections, mitigations, and limitations as {% data variables.copilot.copilot_cloud_agent %}. See [AUTOTITLE](/copilot/concepts/agents/about-third-party-coding-agents). - -### {% data variables.copilot.copilot_code-review_short %} - -AI-generated code review suggestions to help you write better code. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review). - -Several {% data variables.copilot.copilot_code-review-tools_short %} are in {% data variables.release-phases.public_preview %} and subject to change. See [AUTOTITLE](/copilot/concepts/agents/code-review). - -### Agent mode in IDEs - -Allow {% data variables.product.prodname_copilot_short %} to work autonomously in the IDE. {% data variables.product.prodname_copilot_short %} will determine which files to make changes to, offer code changes and terminal commands for the user's approval, and iterate to remediate issues until the original task is complete. - -## Features for customization - -These features can be used to add context to {% data variables.product.prodname_copilot_short %} and improve its performance. For a comparison of when to use each feature, see [AUTOTITLE](/copilot/reference/customization-cheat-sheet). - -### {% data variables.copilot.copilot_spaces %} - -Organize and centralize relevant content—like code, docs, specs, and more—into {% data variables.copilot.copilot_spaces_short %} that ground {% data variables.product.prodname_copilot_short %}’s responses in the right context for a specific task. See [AUTOTITLE](/copilot/concepts/context/spaces). - -### Custom instructions - -Enhance responses by providing contextual details on your preferences, tools, and requirements. See [AUTOTITLE](/copilot/concepts/prompting/response-customization). - -### {% data variables.copilot.copilot_memory %} ({% data variables.release-phases.public_preview %}) - -{% data variables.product.prodname_copilot_short %} can deduce and store useful information about a repository, which {% data variables.copilot.copilot_cloud_agent %} and {% data variables.copilot.copilot_code-review_short %} can use to improve the quality of their output when working in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). - -### Prompt files - -Build and share reusable prompt instructions with additional context. A prompt file is a Markdown file, stored in your workspace, that mimics the existing format of writing prompts. See [AUTOTITLE](/copilot/concepts/prompting/response-customization#about-prompt-files). - -### MCP servers - -You can configure Model Context Protocol (MCP) servers for many {% data variables.product.prodname_copilot_short %} features, giving {% data variables.product.prodname_copilot_short %} access to external tools or data sources. See [AUTOTITLE](/copilot/concepts/context/mcp). - -### Agent skills - -Create folders of instructions, scripts, and resources that {% data variables.product.prodname_copilot_short %} can load when relevant to improve its performance in specialized tasks. See [AUTOTITLE](/copilot/concepts/agents/about-agent-skills). - -### Custom agents - -Create specialized versions of {% data variables.copilot.copilot_cloud_agent %} with access to specific tools, instructions, and MCP servers. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents). - -## Features for administrators - -The following features are available to organization and enterprise owners with a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan. - -### Policy management - -Manage policies for {% data variables.product.prodname_copilot_short %} in your organization or enterprise. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). - -### Access management - -Enterprise owners can specify which organizations in the enterprise can use {% data variables.product.prodname_copilot_short %}, and organization owners can specify which organization members can use Copilot. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-access) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-access). - -### Usage data - -Review {% data variables.product.prodname_copilot_short %} usage data within your organization or enterprise to inform how to manage access and drive adoption of {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/review-activity/review-user-activity-data) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-access/view-license-usage). - -### Audit logs - -Review audit logs for {% data variables.product.prodname_copilot_short %} in your enterprise to understand what actions have been taken and by which users. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/review-audit-logs). - -### File exclusions - -Configure {% data variables.product.prodname_copilot_short %} to ignore certain files. This can be useful if you have files that you don't want to be available to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot). - -## Next steps - -* To learn more about the plans available for {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/get-started/plans). -* To start using {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/how-tos/set-up). diff --git a/content/copilot/get-started/index.md b/content/copilot/get-started/index.md index 62e71e31c8f0..95dcd85a9018 100644 --- a/content/copilot/get-started/index.md +++ b/content/copilot/get-started/index.md @@ -5,13 +5,14 @@ intro: 'Learn how to sign up for and use {% data variables.product.prodname_copi versions: feature: copilot children: - - /quickstart + - /about-github-copilot + - /where-to-use-github-copilot + - /quickstart-for-using-github-copilot-on-github-com + - /quickstart-for-using-github-copilot-in-your-ide - /cli-quickstart - /quickstart-copilot-app - /sdk-quickstart - - /what-is-github-copilot - /plans - - /features - /best-practices - /enterprise-ai-governance redirect_from: diff --git a/content/copilot/get-started/plans.md b/content/copilot/get-started/plans.md index bcf808ebc22b..97d3deaad128 100644 --- a/content/copilot/get-started/plans.md +++ b/content/copilot/get-started/plans.md @@ -10,7 +10,7 @@ redirect_from: - /copilot/get-started/plans-for-github-copilot - /copilot/concepts/billing/individual-plans contentType: get-started -category: +category: - Learn about Copilot --- diff --git a/content/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide.md b/content/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide.md new file mode 100644 index 000000000000..68b350659b10 --- /dev/null +++ b/content/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide.md @@ -0,0 +1,81 @@ +--- +title: Quickstart for using GitHub Copilot in your IDE +shortTitle: Copilot in your IDE +intro: 'Use {% data variables.product.prodname_copilot_short %} in your IDE to explain concepts, complete code, propose edits, and validate files with agent mode.' +allowTitleToDifferFromFilename: true +versions: + feature: copilot +redirect_from: + - /copilot/getting-started-with-github-copilot + - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code + - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide + - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim + - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio + - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code + - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide + - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim + - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio + - /copilot/using-github-copilot/getting-started-with-github-copilot + - /copilot/quickstart +contentType: get-started +category: + - Learn about Copilot +--- + +{% data variables.product.prodname_copilot %} is available in supported IDEs: {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, {% data variables.product.prodname_jetbrains_ides %}, Eclipse, and XCode. It can answer questions and explain concepts, and suggest or complete code as you work. In IDEs that support agent mode, it can also propose edits and validate files. + +This quickstart shows you how to use these capabilities. It takes about ten minutes. + +## Prerequisites + +* **An active {% data variables.product.prodname_copilot_short %} plan.** See [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +* **The {% data variables.product.prodname_copilot_short %} extension for your IDE.** See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension). +* **Signed in to {% data variables.product.company_short %} in your IDE.** If you have authentication problems, see [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues). + +## Ask a question about your code + +1. Open an existing code file in your editor. +1. Open the {% data variables.copilot.copilot_chat_short %} window. + + The way you do this depends on your IDE. + * In {% data variables.product.prodname_vscode %}, press Ctrl+Alt+I (Windows/Linux) or Control+Command+I (macOS). + * In other IDEs, look for {% data variables.copilot.copilot_chat_short %} in the menu bar or sidebar. See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). + +1. Type `what does this file do`, then press Enter. + + {% data variables.product.prodname_copilot_short %}'s answer displays below your question. + +1. Select a line of code in the editor, then type `explain this line` in the chat window. + +{% data variables.product.prodname_copilot_short %} can see the file you have open, so you can ask about your code instead of describing it first. + +## Let {% data variables.product.prodname_copilot_short %} work through a task + +Most IDEs support **agent mode**. In agent mode, you describe what you want, and {% data variables.product.prodname_copilot_short %} decides which files to change, makes the edits, and runs commands with your approval. + +To check whether your IDE supports agent mode, see [AUTOTITLE](/copilot/reference/copilot-feature-matrix?tool=ides). + +1. In the chat window, select **Agent**, then describe a task. For example, `Create a task manager web app with the ability to add, delete, and mark tasks as completed`. +1. Press Enter. + + {% data variables.product.prodname_copilot_short %} generates the files and code needed. + +1. Review the changes, then use your IDE's controls to accept them. + +When you're ready, save your changes, and commit when everything looks good. + +## Get your first inline suggestion + +{% data variables.product.prodname_copilot %} can suggest code as you work and supports many programming languages. This example uses JavaScript, but you can follow along in your preferred language. + +1. In your IDE, create a new JavaScript (_*.js_) file. +{% data reusables.copilot.type-function-header %} + {% data variables.product.prodname_copilot_short %} will automatically suggest an entire function body in grayed text. The exact suggestion may vary. +1. {% data reusables.copilot.accept-suggestion %} + +When you're ready, save your changes, and commit when everything looks good. + +## Next steps + +* Customize {% data variables.product.prodname_copilot_short %} in your IDE with custom instructions. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions-in-your-ide/add-repository-instructions-in-your-ide#further-reading). +* Try the {% data variables.copilot.github_copilot_app %}. See [AUTOTITLE](/copilot/get-started/quickstart-copilot-app). diff --git a/content/copilot/get-started/quickstart-for-using-github-copilot-on-github-com.md b/content/copilot/get-started/quickstart-for-using-github-copilot-on-github-com.md new file mode 100644 index 000000000000..4d9539c4f1b0 --- /dev/null +++ b/content/copilot/get-started/quickstart-for-using-github-copilot-on-github-com.md @@ -0,0 +1,84 @@ +--- +title: Quickstart for using GitHub Copilot on GitHub.com +shortTitle: Copilot on GitHub.com +intro: 'Understand code and work faster by asking questions and assigning coding tasks to {% data variables.copilot.copilot_cloud_agent %} without leaving {% data variables.product.github %}.' +allowTitleToDifferFromFilename: true +versions: + feature: copilot +redirect_from: + - /copilot/get-started/quickstart +contentType: get-started +category: + - Learn about Copilot +--- + +{% data variables.product.prodname_copilot %} is built into {% data variables.product.github %}, so you can use it without installing anything. + +This quickstart shows how to ask questions about code and assign a coding task to {% data variables.copilot.copilot_cloud_agent %}. It takes about ten minutes. + +## Step 1: Ask {% data variables.product.prodname_copilot_short %} about a file + +1. Try these prompts to explore specific files in the `github/docs` repository. + + ```copilot prompt + In `github/docs`, look at `/package.json` and explain what this file does. + ``` + + ```copilot prompt + In `github/docs`, look at `/src/color-schemes/tests/color-mode-script.ts` and share how I could improve this code. + ``` + +Next, open a file in a repository of your choice and ask {% data variables.product.prodname_copilot_short %} questions about it. + +1. Navigate to any repository you want to explore. It doesn't need to be your own. +1. Open any file in the repository. +1. Click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) at the top right of the file view. +1. In the prompt box, type a question and press Enter. For example: + * {% prompt %}Explain what this file does.{% endprompt %} + * {% prompt %}How could I improve this code?{% endprompt %} + * {% prompt %}What tests would cover this function?{% endprompt %} + * {% prompt %}What was the last change and why was it made?{% endprompt %} + + {% data variables.product.prodname_copilot_short %} responds in the chat panel. +1. Ask follow-up questions to explore the code further. For example: + * {% prompt %}Tell me more{% endprompt %} to get {% data variables.product.prodname_copilot_short %} to expand on its last comment + * Ask exploratory questions about a repository + * Explain the changes in a pull request + * Ask a question about a specific issue or commit + +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github). + +## Step 2: Assign an issue to {% data variables.product.prodname_copilot_short %} + +> [!NOTE] +> To use {% data variables.copilot.copilot_cloud_agent %} in this quickstart, upgrade to a paid plan such as [{% data variables.copilot.copilot_pro_short %}](https://github.com/github-copilot/signup?ref_product=copilot&ref_type=purchase&ref_style=text&ref_plan=pro). +> +> Without access to a paid plan, you can instead learn about the remaining steps by using {% data variables.product.prodname_copilot_short %} in your preferred editor. See [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide). + +{% data variables.copilot.copilot_cloud_agent %} can work on coding tasks autonomously. Assigning an issue is the easiest way to start, and {% data variables.product.prodname_copilot_short %} creates a pull request when it finishes. + +1. In a personal repository you have write access to, enable {% data variables.copilot.copilot_cloud_agent %} from your [{% data variables.product.prodname_copilot_short %} settings](https://github.com/settings/copilot?ref_product=copilot&ref_type=engagement&ref_style=text). + + * To enable {% data variables.copilot.copilot_cloud_agent %} for repositories in an organization or enterprise instead, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot) for further instructions. + +1. Find an existing issue you'd like {% data variables.product.prodname_copilot_short %} to work on, or create a new issue. +1. Open the issue. In the right sidebar of the issue, click **Assignees**. +1. Click **Copilot** from the assignees list. +1. Optionally, add context in the **Optional prompt** field—for example, coding patterns, files to modify, or testing requirements. + +{% data variables.product.prodname_copilot_short %} uses the issue title, description, and existing comments. Add follow-up information directly to the pull request after it opens. + +## Step 3: Review the resulting pull request + +When {% data variables.product.prodname_copilot_short %} finishes the task, it opens a pull request and requests your review. + +1. Open the pull request that {% data variables.product.prodname_copilot_short %} created. +1. Review the diff and verify the changes match what you intended. +1. To request changes, mention `@copilot` in a comment on the pull request, or push commits directly to the branch. +1. When you're satisfied with the changes, merge the pull request. + +For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/review-copilot-output). + +## Next steps + +* **Experiment with using {% data variables.copilot.copilot_cloud_agent %}** for research and multitasking. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/use-copilot-agents/overview) diff --git a/content/copilot/get-started/quickstart.md b/content/copilot/get-started/quickstart.md deleted file mode 100644 index 43964e0fca37..000000000000 --- a/content/copilot/get-started/quickstart.md +++ /dev/null @@ -1,420 +0,0 @@ ---- -title: Quickstart for GitHub Copilot -intro: 'Quickly learn how to use {% data variables.product.prodname_copilot %}.' -allowTitleToDifferFromFilename: true -versions: - feature: copilot -redirect_from: - - /copilot/getting-started-with-github-copilot - - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code - - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide - - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim - - /github/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio - - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code - - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide - - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-neovim - - /copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio - - /copilot/using-github-copilot/getting-started-with-github-copilot - - /copilot/quickstart -shortTitle: Quickstart -contentType: get-started -category: - - Configure Copilot ---- - -This quickstart covers using {% data variables.product.prodname_copilot_short %} on the {% data variables.product.github %} website, in IDEs, and in {% data variables.product.prodname_windows_terminal %}. To try an agent-driven workflow in the {% data variables.copilot.github_copilot_app %}, see [AUTOTITLE](/copilot/get-started/quickstart-copilot-app). - -## Introduction - - - - - -{% webui %} - -You can use {% data variables.product.prodname_copilot_short %} to get answers to coding-related questions, such as how best to code something, how to fix a bug, or how someone else's code works. For full details of what {% data variables.product.prodname_copilot_short %} can do, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot). - -Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for using {% data variables.product.prodname_copilot_short %} on the {% data variables.product.github %} website. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments. - -{% ifversion fpt %} -{% data reusables.copilot.quickstart-signup %} -{% endif %} - -{% ifversion ghec %} - -## Prerequisite - -To use {% data variables.product.prodname_copilot_short %} on the {% data variables.product.github %} website, you must have an active {% data variables.product.prodname_copilot_short %} plan. {% data reusables.copilot.subscription-prerequisite %} -{% endif %} - -## Asking your first question - -1. On {% data variables.product.github %}, navigate to a repository and open a file. -1. Click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) at the top right of the file view. - - ![Screenshot of the {% data variables.product.prodname_copilot_short %} button, highlighted with a dark orange outline, at the top of the file view.](/assets/images/help/copilot/copilot-button-for-file.png) - -1. Type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and press Enter. - - For example, you could enter: - - * `Explain this file.` - * `How could I improve this code?` - * `How can I test this code?` - - {% data variables.product.prodname_copilot_short %} responds to your request in the panel. - -1. You can continue the conversation by asking a follow-up question. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment. - -## Other questions you can ask - -There are many more things you can do with {% data variables.copilot.copilot_chat_dotcom %}. For example: - -* Ask a general question about software development -* Ask exploratory questions about a repository -* Find out about the changes in a pull request -* Ask a question about a specific issue or commit - -For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github). - -## Next steps - -* **Find out more about {% data variables.copilot.copilot_chat %}** - See [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide){% ifversion fpt %}.{% endif %}{% ifversion ghec %} and [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github).{% endif %} -* **Get {% data variables.product.prodname_copilot_short %} inline suggestions in an IDE** - See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions). -* **Learn how to write effective prompts** - See [AUTOTITLE](/copilot/concepts/prompting/prompt-engineering). -* **Use {% data variables.product.prodname_copilot_short %} on your mobile device** - See [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-mobile). -* **Use {% data variables.product.prodname_copilot_short %} on the command line** - See [AUTOTITLE](/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-in-the-cli). - -{% endwebui %} - - - - - -{% windowsterminal %} - -{% data reusables.copilot.quickstart-intro %} - -Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for {% data variables.product.prodname_windows_terminal %}. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments. - -{% ifversion fpt %} -{% data reusables.copilot.quickstart-signup %} -{% endif %} - -## Prerequisites - -* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_windows_terminal %}, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -* **{% data variables.product.prodname_windows_terminal %} Canary**. Terminal Chat is only available in [{% data variables.product.prodname_windows_terminal %} Canary](https://github.com/microsoft/terminal?tab=readme-ov-file#installing-windows-terminal-canary). - -## Use {% data variables.product.prodname_copilot_short %} in Terminal Chat - -After you've installed {% data variables.product.prodname_windows_terminal %} Canary, you can use {% data variables.product.prodname_copilot_short %} in [Terminal Chat](https://learn.microsoft.com/windows/terminal/terminal-chat) to ask command line-related questions. - -1. Open **Settings** from the dropdown menu. - - ![Screenshot of the dropdown menu in the {% data variables.product.prodname_windows_terminal %} with the Settings item highlighted.](/assets/images/help/copilot/windows-terminal-dropdown.png) - -1. Go to the **Terminal Chat (Experimental)** setting. - - ![Screenshot of the Settings menu in the {% data variables.product.prodname_windows_terminal %} with the Terminal Chat (Experimental) item highlighted.](/assets/images/help/copilot/windows-terminal-settings.png) - -1. Under **Service Providers**, select **GitHub Copilot** and **Authenticate via GitHub** to sign in. - -## Chat with {% data variables.product.prodname_copilot %} - -> [!NOTE] {% data reusables.copilot.windows-terminal-access-denied %} - -1. Open **Terminal Chat (Experimental)** in the dropdown menu. - -1. In the Terminal Chat window, type `how do i list all markdown files in my directory` then press Enter. - - {% data variables.product.prodname_copilot_short %}'s answer is displayed below your question. - -1. Click on an answer to insert it to the command line. - -## Next steps - -{% data reusables.copilot.quickstart-nextsteps1 %} -{% data reusables.copilot.quickstart-nextsteps2 %} - -{% endwindowsterminal %} - - - - - -{% vscode %} - -{% data reusables.copilot.quickstart-intro %} - -Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for {% data variables.product.prodname_vscode %}. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments. - -{% ifversion fpt %} -{% data reusables.copilot.quickstart-signup %} -{% endif %} - -## Prerequisites - -* **{% data variables.product.prodname_copilot_short %} subscription** - To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode_shortname %}, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -{% data reusables.copilot.vscode-prerequisites %} - -## Chat with {% data variables.product.prodname_copilot %} - -After you've installed the {% data variables.product.prodname_copilot %} Chat extension, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions. - -> [!NOTE] {% data reusables.copilot.chat-access-denied %} - -1. Create a new folder for your project and open it in VS Code. -1. Open the Chat view by pressing Control+Command+i (Mac) / Ctrl+Alt+i (Windows/Linux) or by selecting the chat icon in the VS Code title bar. -1. At the bottom of the chat view, in the chat input field, type: `Create a complete task manager web application with the ability to add, delete, and mark tasks as completed. Include modern CSS styling and make it responsive. Use semantic HTML and ensure it's accessible. Separate markup, styles, and scripts into their own files.` -1. Press Enter. Watch as the agent generates the necessary files and code to implement your request. You should see it update the `index.html` file, create a `styles.css` file for styling, and a `script.js` file for functionality. -1. Review the generated files and select Keep to accept all the changes. - -## Get your first inline suggestion - -The following example uses JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %} - -1. Open {% data variables.product.prodname_vscode %}. -{% data reusables.copilot.create-js-file %} -{% data reusables.copilot.type-function-header %} - {% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. The exact suggestion may vary. -1. {% data reusables.copilot.accept-suggestion %} - -## Next steps - -{% data reusables.copilot.quickstart-nextsteps1 %} -* **Use {% data variables.product.prodname_copilot_short %} like a pro** - Learn how to write effective prompts for {% data variables.product.prodname_copilot %}. For more information, see [Best practices for using {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/copilot/prompt-crafting) in the {% data variables.product.prodname_vscode %} documentation. -* **Get familiar with {% data variables.copilot.next_edit_suggestions %}** - See [Navigating and accepting {% data variables.copilot.next_edit_suggestions %}](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions#navigating-and-accepting-next-edit-suggestions-1). -{% data reusables.copilot.quickstart-nextsteps2 %} - -{% endvscode %} - - - - - -{% visualstudio %} - -{% data reusables.copilot.quickstart-intro %} - -Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for {% data variables.product.prodname_vs %}. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments. - -{% ifversion fpt %} -{% data reusables.copilot.quickstart-signup %} -{% endif %} - -## Prerequisites - -* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -{% data reusables.copilot.visual-studio-prerequisites %} - -## Chat with {% data variables.product.prodname_copilot %} - -After you've installed the {% data variables.product.prodname_copilot %} extension, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions. - -> [!NOTE] {% data reusables.copilot.chat-access-denied %} - -1. Open an existing code file. -1. In the {% data variables.product.prodname_vs %} menu bar, click **View**, then click **{% data variables.copilot.copilot_chat %}**. -1. In the {% data variables.copilot.copilot_chat_short %} window, type `what does this file do` then press Enter. - - {% data variables.product.prodname_copilot_short %}'s answer is displayed below your question. - -1. Select a line of code in the editor. -1. In the {% data variables.copilot.copilot_chat_short %} window, type `explain this line` then press Enter. - -## Get your first inline suggestion - -The following example uses JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %} - -1. Open {% data variables.product.prodname_vs %}. -1. In {% data variables.product.prodname_vs %}, create a new JavaScript (_*.js_) file. -{% data reusables.copilot.type-function-header %} - {% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. The exact suggestion may vary. -1. {% data reusables.copilot.accept-suggestion %} - -## Next steps - -{% data reusables.copilot.quickstart-nextsteps1 %} -* **Prompt like a pro** - Watch [{% data variables.product.prodname_vs %} Prompt Engineering with {% data variables.product.prodname_copilot %}](https://www.youtube.com/watch?v=9hZsOeIINg8&list=PLReL099Y5nRckZDdcQ21UigO9pKa14yxC) on YouTube. -{% data reusables.copilot.quickstart-nextsteps2 %} - -{% endvisualstudio %} - - - - - -{% jetbrains %} - -{% data reusables.copilot.quickstart-intro %} - -Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for JetBrains IDEs. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments. - -{% ifversion fpt %} -{% data reusables.copilot.quickstart-signup %} -{% endif %} - -## Prerequisites - -* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in a JetBrains IDE, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -* **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot_short %} is supported in a large number of JetBrains IDEs. For a full list, see [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide?tool=jetbrains). -{% data reusables.copilot.jetbrains-plugin-prerequisites %} - -## Chat with {% data variables.product.prodname_copilot %} - -After you've installed the {% data variables.product.prodname_copilot %} plugin, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions. - -> [!NOTE] {% data reusables.copilot.chat-access-denied %} - -1. Open an existing code file. -1. Open the {% data variables.copilot.copilot_chat_short %} window by clicking the **{% data variables.copilot.copilot_chat_short %}** icon at the right side of the JetBrains IDE window. - - ![Screenshot of the {% data variables.copilot.copilot_chat_short %} icon in the Activity Bar.](/assets/images/help/copilot/jetbrains-copilot-chat-icon.png) - -1. In the {% data variables.copilot.copilot_chat_short %} window, type `what does this file do` then press Enter. - - {% data variables.product.prodname_copilot_short %}'s answer is displayed below your question. - -1. Select a line of code in the editor. -1. In the {% data variables.copilot.copilot_chat_short %} window, type `explain this line` then press Enter. - -## Get your first inline suggestion - -The following example uses JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %} - -1. In your JetBrains editor, create a new JavaScript (_*.js_) file. -{% data reusables.copilot.type-function-header %} - {% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. The exact suggestion may vary. -1. {% data reusables.copilot.accept-suggestion %} - -## Next steps - -{% data reusables.copilot.quickstart-nextsteps1 %} -{% data reusables.copilot.quickstart-nextsteps2 %} - -{% endjetbrains %} - - - - - -{% xcode %} - -{% data reusables.copilot.quickstart-intro %} - -Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for XCode in MacOS. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments. - -{% ifversion fpt %} -{% data reusables.copilot.quickstart-signup %} -{% endif %} - -## Prerequisites - -* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Xcode, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -* **Latest version of the {% data variables.product.prodname_copilot %} extension**. For installation instructions, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=xcode). -* **Sign in to {% data variables.product.company_short %} in Xcode**. If you experience authentication issues, see [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues). - -## Chat with {% data variables.product.prodname_copilot %} - -After you've installed the {% data variables.product.prodname_copilot %} plugin, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions. - -> [!NOTE] {% data reusables.copilot.chat-access-denied %} - -1. Open an existing code file. -1. Click **Editor** in the menu bar, then click **{% data variables.product.prodname_copilot %}** then **Open Chat**. - - {% data variables.copilot.copilot_chat_short %} opens in a new window. - -1. In the {% data variables.copilot.copilot_chat_short %} window, select the file to indicate that you want to chat about this file. - - ![Screenshot of a file selected in the Chat window. The file is highlighted with a dark orange outline.](/assets/images/help/copilot/xcode-chat-about-file.png) - -1. Type `what does this file do` then press Enter. - - {% data variables.product.prodname_copilot_short %}'s answer is displayed below your question. - -1. Select a line of code in the editor. -1. In the {% data variables.copilot.copilot_chat_short %} window, type `explain this line` then press Enter. - -## Get your first inline suggestion - -The following example uses Swift, however other languages will work similarly. - -1. Create a new file called `CalculateDays.swift`. -1. Type the following code in the new file: - - ```swift copy - import Foundation - - func calculateDaysBetweenDates(_ start: Date, _ end: Date) - ``` - - {% data variables.product.prodname_copilot %} adds a suggestion of code that continues this function. Suggestions are displayed in grayed text. -1. {% data reusables.copilot.accept-suggestion %} -1. {% data variables.product.prodname_copilot_short %} will continue to make suggestions, each of which you can accept by pressing Tab. - -## Next steps - -{% data reusables.copilot.quickstart-nextsteps1 %} -* **Get familiar with {% data variables.copilot.next_edit_suggestions %}** - See [Navigating and accepting {% data variables.copilot.next_edit_suggestions %}](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions?tool=xcode#navigating-and-accepting-next-edit-suggestions-2). -{% data reusables.copilot.quickstart-nextsteps2 %} - -{% endxcode %} - - - - - -{% eclipse %} - -{% data reusables.copilot.quickstart-intro %} - -Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for Eclipse. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments. - -{% ifversion fpt %} -{% data reusables.copilot.quickstart-signup %} -{% endif %} - -## Prerequisites - -* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Eclipse, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -* **Latest version of the {% data variables.product.prodname_copilot %} extension**. For installation instructions, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=eclipse). -* **Sign in to {% data variables.product.company_short %} in Eclipse**. If you experience authentication issues, see [AUTOTITLE](/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues). - -## Chat with {% data variables.product.prodname_copilot %} - -After you've installed the {% data variables.product.prodname_copilot %} plugin, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions. - -> [!NOTE] {% data reusables.copilot.chat-access-denied %} - -1. Open an existing code file. -1. In the menu bar of Eclipse, click **{% data variables.product.prodname_copilot_short %}**, then click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} Open Chat**. -1. In the {% data variables.copilot.copilot_chat_short %} window, type `what does this file do` then press Enter. - - {% data variables.product.prodname_copilot_short %}'s answer is displayed below your question. - -1. Select a line of code in the editor. -1. In the {% data variables.copilot.copilot_chat_short %} window, type `explain this line` then press Enter. - -## Get your first inline suggestion - -The following example uses Java, however other languages will work similarly. - -1. Create a new Java class called `CalculateDaysBetween`. -1. Within the class add the following comment: - - ```java copy - // Take 2 dates and return the number of days between them - ``` - - {% data variables.product.prodname_copilot %} adds a suggestion of code to use for this class. Suggestions are displayed in grayed text. -1. {% data reusables.copilot.accept-suggestion %} - -## Next steps - -{% data reusables.copilot.quickstart-nextsteps1 %} -* **Get familiar with {% data variables.copilot.next_edit_suggestions %}** - See [Navigating and accepting {% data variables.copilot.next_edit_suggestions %}](/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions?tool=eclipse#navigating-and-accepting-next-edit-suggestions-3). -{% data reusables.copilot.quickstart-nextsteps2 %} - -{% endeclipse %} diff --git a/content/copilot/get-started/what-is-github-copilot.md b/content/copilot/get-started/what-is-github-copilot.md deleted file mode 100644 index dcce38943409..000000000000 --- a/content/copilot/get-started/what-is-github-copilot.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: What is GitHub Copilot? -intro: 'Learn what {% data variables.product.prodname_copilot_short %} is and what you can do with it.' -versions: - feature: copilot -shortTitle: What is GitHub Copilot? -redirect_from: - - /copilot/copilot-individual - - /copilot/copilot-individual/about-github-copilot-individual - - /copilot/copilot-business/about-github-copilot-business - - /copilot/github-copilot-enterprise/about-github-copilot-enterprise - - /copilot/github-copilot-enterprise/overview - - /copilot/overview-of-github-copilot/about-github-copilot-for-individuals - - /copilot/overview-of-github-copilot/about-github-copilot - - /copilot/overview-of-github-copilot/about-github-copilot-individual - - /copilot/overview-of-github-copilot/about-github-copilot-for-business - - /copilot/overview-of-github-copilot/about-github-copilot-business - - /copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise - - /copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization - - /copilot/managing-copilot-business - - /copilot/managing-copilot-for-business - - /copilot/github-copilot-enterprise - - /copilot/copilot-business - - /copilot/about-github-copilot/what-is-github-copilot -contentType: get-started -category: - - Learn about Copilot ---- - -{% data variables.product.prodname_copilot %} is an AI coding assistant that helps you write code faster and with less effort. Then, you can focus more energy on problem solving and collaboration. - -Research shows that {% data variables.product.prodname_copilot_short %} increases developer productivity and accelerates software development. See [Research: quantifying {% data variables.product.prodname_copilot %}’s impact on developer productivity and happiness](https://github.blog/2022-09-07-research-quantifying-github-copilots-impact-on-developer-productivity-and-happiness/) in the {% data variables.product.prodname_dotcom %} blog. - -## Features - -You can use {% data variables.product.prodname_copilot_short %} to: - -* Get code suggestions as you type in your IDE. -* Chat with {% data variables.product.prodname_copilot_short %} to get help with your code. -* Ask for help using the command line. -* Organize and share context with {% data variables.copilot.copilot_spaces %} to get more relevant answers. -* Generate descriptions of changes in a pull request. -* Research, plan, make code changes, and create pull requests for you to review. - -**For enterprises and organizations with data residency requirements:** If you use {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_copilot_short %} can enforce geographic data residency. See [AUTOTITLE](/admin/data-residency/github-copilot-with-data-residency). - -Use {% data variables.product.prodname_copilot_short %} in the following places: - -* Your IDE -* {% data variables.product.prodname_mobile %}, as a chat interface -* {% data variables.product.prodname_windows_terminal %} Canary, through the Terminal Chat interface -* The command line, through the {% data variables.product.prodname_cli %} -* The {% data variables.copilot.github_copilot_app %}, a desktop application for agent-driven development. See [AUTOTITLE](/copilot/concepts/agents/github-copilot-app). -* The {% data variables.product.github %} website - -See [AUTOTITLE](/copilot/get-started/features). - -## Get access - -You can start using {% data variables.product.prodname_copilot_short %} in several ways, depending on your role and needs. - -### Individuals - -* **Try {% data variables.product.prodname_copilot_short %} for free.** Use {% data variables.copilot.copilot_free_short %} to explore core features with no paid plan required. -* **Subscribe to a paid plan.** Upgrade to {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, or {% data variables.copilot.copilot_max_short %} for access to premium features, increased access to models, and higher available monthly allowance of {% data variables.product.prodname_ai_credits_short %}. -* **Get free access if you're eligible.** Students, teachers, and open source maintainers may qualify for access to premium features at no cost. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students) and [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-teachers-and-os-maintainers). -* **Request access from your organization.** If your organization or enterprise has a {% data variables.product.prodname_copilot %} plan, you can request access by going to [https://github.com/settings/copilot](https://github.com/settings/copilot) and request access under "Get {% data variables.product.prodname_copilot_short %} from an organization." - -See [AUTOTITLE](/copilot/how-tos/manage-your-account/get-started-with-a-copilot-plan) for more information. - -### Organizations and enterprises - -{% data reusables.copilot.plans.subscribe-for-org %} - -{% data reusables.copilot.plans.subscribe-for-enterprise %} - -## Next steps - -* Learn more about {% data variables.product.prodname_copilot_short %} features. See [AUTOTITLE](/copilot/get-started/features). -* Start using {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/how-tos/set-up). - -## Further reading - -* [Frequently asked questions](https://github.com/features/copilot#faq) about {% data variables.product.prodname_copilot %} -* [{% data variables.product.prodname_copilot %} Trust Center](https://copilot.github.trust.page/) diff --git a/content/copilot/get-started/where-to-use-github-copilot.md b/content/copilot/get-started/where-to-use-github-copilot.md new file mode 100644 index 000000000000..98d5c079e37c --- /dev/null +++ b/content/copilot/get-started/where-to-use-github-copilot.md @@ -0,0 +1,76 @@ +--- +title: Where to use GitHub Copilot +shortTitle: Where to use Copilot +intro: 'Choose where to work with {% data variables.product.prodname_copilot %}, from understanding an issue to writing, reviewing, testing, and shipping code.' +versions: + feature: copilot +contentType: get-started +category: + - Learn about Copilot +--- + +Use {% data variables.product.prodname_copilot %} in the tools you already use to plan, build, review, test, and ship software. + +The {% data variables.copilot.github_copilot_app %} is the best place to do it all in one workflow: manage agent-driven work across parallel tasks, coordinate work across repositories, and keep the browser, terminal, and pull request lifecycle connected in one place. + +You can also ask questions in your browser, get suggestions while editing code in your IDE, work from the terminal, or build your own {% data variables.product.prodname_copilot_short %}-powered tools with the SDK. + +If you’re not sure where to start, choose a surface based on the coding work you want to do now. Surfaces can have overlapping use cases: some support broad, multi-step workflows, while others focus on specific tasks. + +## Where you can use {% data variables.product.prodname_copilot_short %} + +| Where | Use it for | Get started | +| ----- | ---------- | ----------- | +| **{% data variables.copilot.github_copilot_app %}** | Managing your developer and agent-driven work across parallel tasks, multiple repositories, and the pull request lifecycle in one dedicated workspace. | [AUTOTITLE](/copilot/get-started/quickstart-copilot-app) | +| **{% data variables.copilot.copilot_cli %}** | Working with {% data variables.product.prodname_copilot_short %} from the terminal, including repeatable command-line workflows. | [AUTOTITLE](/copilot/get-started/cli-quickstart) | +| **Your IDE**
({% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, {% data variables.product.prodname_jetbrains_ides %}, Eclipse, and XCode) | Getting inline suggestions, chatting about nearby code, and using an agent that can edit files for you. | [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide) | +| **{% data variables.copilot.copilot_sdk %}** | Building custom applications that use the same primitives as {% data variables.product.prodname_copilot_short %}. | [AUTOTITLE](/copilot/get-started/sdk-quickstart) | +| **{% data variables.product.github %} website** | Asking questions about repositories, issues, and pull requests, or assigning work to an agent. | [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-on-github-com) | +| **{% data variables.product.prodname_mobile %}** | Chatting with {% data variables.product.prodname_copilot_short %} while away from your main development environment. | [AUTOTITLE](/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-mobile) | +| **{% data variables.product.prodname_desktop %}** | Getting help with commit messages and summaries. | [AUTOTITLE](/desktop/configuring-and-customizing-github-desktop/configuring-copilot-in-github-desktop) | + +To check which {% data variables.product.prodname_copilot_short %} features are available to your personal account, go to your {% data variables.product.prodname_copilot_short %} settings at [https://github.com/settings/copilot/features](https://github.com/settings/copilot/features?ref_product=copilot&ref_type=engagement&ref_style=text). + +To compare support across IDEs, see [AUTOTITLE](/copilot/reference/copilot-feature-matrix). + +## Which one is right for me? + +You do not need to use every surface. Choose the one closest to the work you are doing now. + +If you are not sure where to start, use {% data variables.product.prodname_copilot_short %} on the {% data variables.product.github %} website. There is nothing to install, and you can ask questions about a repository, issue, or pull request you already have open. + +Use these common development contexts to choose a surface: + +* **Coordinating agent work**: Use the {% data variables.copilot.github_copilot_app %} when you want one place to coordinate agent work, manage parallel workstreams, work across multiple repositories, and keep the browser, terminal, and pull request lifecycle connected. +* **Running commands**: Use {% data variables.copilot.copilot_cli %} when you want to work in the terminal, run complex terminal commands, and execute tasks in parallel. For agent tasks that run commands, use cloud or local sandboxes to control where commands run and what they can access. +* **Writing code**: Use {% data variables.product.prodname_copilot %} in your IDE when you want to write and refine your code interactively. +* **Extending your own tools**: Use {% data variables.copilot.copilot_sdk %} when you are building an application or internal workflow that calls {% data variables.product.prodname_copilot_short %} directly. +* **Planning a change**: Use the {% data variables.product.github %} website when the work starts from an issue, pull request, or unfamiliar repository. +* **Checking work away from your desk**: Use {% data variables.product.prodname_mobile %} when you need to ask a quick question from a mobile device. + +You can switch surfaces later, often without starting over. For example, you might understand an issue in the web interface, ask an agent to make a change, review the pull request in your IDE, and then follow up from the terminal. + +## How the surfaces work together + +Some context, permissions, and configuration can carry between surfaces. The settings and context that apply depend on the {% data variables.product.prodname_copilot_short %} feature and the surface you use. + +Where supported, your plan, custom instructions, agent skills, and connected MCP servers apply across the places where you use {% data variables.product.prodname_copilot_short %}, so you can configure them once and use them in different parts of your workflow. + +A single piece of work can move between surfaces. For example, you can start with an issue on {% data variables.product.github %}, assign it to {% data variables.copilot.copilot_cloud_agent %}, track the work in the {% data variables.copilot.github_copilot_app %}, review the pull request in your IDE, and merge it in the web interface. + +You can also start {% data variables.product.prodname_copilot_short %} working on a task in your terminal, then continue the same session in your browser or on your mobile device. + +The surfaces also share the same foundation. The {% data variables.product.prodname_copilot_short %} experiences you use across surfaces are all powered by the same SDK and platform primitives. You can use that same SDK to build {% data variables.product.prodname_copilot_short %} into your own applications, tools, and workflows, so custom integrations and first-party {% data variables.product.prodname_copilot_short %} experiences all work with the same underlying capabilities. + +Your choices hold across the workflow, including: + +* **Which model**: Different models suit different kinds of work, and you can switch models for chat and agents. See [AUTOTITLE](/copilot/how-tos/use-ai-models/change-the-chat-model). +* **Which agents**: {% data variables.product.prodname_copilot_short %} agents and agents from other providers work in the same repositories, open pull requests, and go through review. {% data variables.product.prodname_copilot_short %} applies the same security protections, mitigations, and limitations to third-party agents as it does to {% data variables.copilot.copilot_cloud_agent %}. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) and [AUTOTITLE](/copilot/concepts/agents/about-third-party-coding-agents). +* **What {% data variables.product.prodname_copilot_short %} can see**: Custom instructions, agent skills, and MCP servers connect {% data variables.product.prodname_copilot_short %} to your conventions and to the tools your team uses. See [AUTOTITLE](/copilot/concepts/context/mcp). +* **What {% data variables.product.prodname_copilot_short %} remembers**: For supported features, {% data variables.copilot.copilot_memory %} can reuse repository facts and your preferences in later work. See [AUTOTITLE](/copilot/concepts/agents/copilot-memory). + +For organizations, administrator policies apply across most surfaces developers use. See [AUTOTITLE](/copilot/how-tos/administer-copilot). + +## Next steps + +* Compare the available {% data variables.product.prodname_copilot_short %} plans. See [AUTOTITLE](/copilot/get-started/plans). diff --git a/content/copilot/how-tos/chat-with-copilot/chat-in-windows-terminal.md b/content/copilot/how-tos/chat-with-copilot/chat-in-windows-terminal.md index d1c2e32ec159..4856c21cd494 100644 --- a/content/copilot/how-tos/chat-with-copilot/chat-in-windows-terminal.md +++ b/content/copilot/how-tos/chat-with-copilot/chat-in-windows-terminal.md @@ -11,15 +11,15 @@ redirect_from: - /copilot/how-tos/use-chat/use-chat-in-windows-terminal - /copilot/how-tos/chat-with-copilot/use-chat-in-windows-terminal contentType: how-tos -category: +category: - Author and optimize with Copilot --- ## Prerequisites -* **Access to {% data variables.product.prodname_copilot %}**. See [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +* **Access to {% data variables.product.prodname_copilot %}**. See [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). * **{% data variables.product.prodname_windows_terminal %} Canary installed**. For installation instructions, see [Installing {% data variables.product.prodname_windows_terminal %} Canary](https://github.com/microsoft/terminal?tab=readme-ov-file#installing-windows-terminal-canary). -* **{% data variables.product.prodname_copilot %} connected to Terminal Chat**. See [AUTOTITLE](/copilot/get-started/quickstart?tool=windowsterminal). +* **{% data variables.product.prodname_copilot %} connected to Terminal Chat**. See [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide). If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %} if your organization owner or enterprise administrator has disabled {% data variables.copilot.copilot_cli_short %}. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies). diff --git a/content/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion.md b/content/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion.md index d6362a0e34cb..1c543b6f7ed7 100644 --- a/content/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion.md +++ b/content/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion.md @@ -47,6 +47,44 @@ Use up and down keyboard keys to navigate through the list of background tasks. Press Esc to exit the task list and return to the main CLI prompt. +## Starting in fleet mode from the command line + +You can start {% data variables.copilot.copilot_cli_short %} in fleet mode directly from the command line by using the `--fleet` option. This is the command-line equivalent of the `/fleet` slash command. It wraps the prompt you supply, so {% data variables.product.prodname_copilot_short %} starts working on it in fleet mode straight away. You don't have to enter `/fleet` in an interactive session. + +The `--fleet` option is not supported in ACP server mode, so you cannot combine it with the `--acp` option. + +You must provide a prompt for {% data variables.product.prodname_copilot_short %} to work on. You can supply the prompt in one of three ways: + +* With the `-i` (interactive) option, to start an interactive session that begins in fleet mode. +* With the `-p` (prompt) option, to run a task without an interactive session. The session exits when the task is complete. +* By piping the prompt in through standard input. + +### When to use the `--fleet` option + +The `--fleet` option is particularly useful for automation, using the `-p` option, when you know that a task can be split into parts that run in parallel. + +For more information about the `-p` option and running tasks without an interactive session, see [AUTOTITLE](/copilot/how-tos/copilot-cli/automate-copilot-cli/run-cli-programmatically). + +### Examples + +Run a task in fleet mode without an interactive session: + +```shell copy +copilot --fleet -p "Refactor the utils package and update everything that calls it" --allow-tool write +``` + +Pipe a prompt into fleet mode: + +```shell copy +echo "Update the project dependencies and run the tests" | copilot --fleet +``` + +Start an interactive session that begins in fleet mode: + +```shell copy +copilot --fleet -i "Add unit tests for every module in the src directory" +``` + ## Further reading * [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference#slash-commands-in-the-interactive-interface) diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md index 84738cde882e..f8b9385dc721 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md @@ -351,13 +351,14 @@ If your MCP servers require any dependencies that are not installed on the {% da The {% data variables.product.github %} MCP server is enabled by default and connects to {% data variables.product.github %} with a specially scoped token that only has read-only access to the current repository. -If you want to allow {% data variables.product.prodname_copilot_short %} to access data outside the current repository, you can give it a {% data variables.product.pat_generic %} with wider access. +If you want to allow {% data variables.product.prodname_copilot_short %} to access data outside the current repository, you can configure a {% data variables.product.pat_generic %} with wider access or a {% data variables.product.prodname_github_app %}. -1. Create a {% data variables.product.pat_generic %} with the appropriate permissions. We recommend using a {% data variables.product.pat_v2 %}, where you can limit the token's access to read-only permissions on specific repositories. For more information on {% data variables.product.pat_generic_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} 1. {% data reusables.user-settings.code-planning-automation %} click **{% data variables.product.prodname_copilot_short %}** then **MCP servers**. -1. Add your configuration in the "MCP configuration" section. For example, you can add the following: +1. Add your configuration in the "MCP configuration" section. + + For {% data variables.product.pat_generic %}, you can add the following example: ```javascript copy // If you copy and paste this example, you will need to remove the comments prefixed with `//`, which are not valid JSON. @@ -378,10 +379,48 @@ If you want to allow {% data variables.product.prodname_copilot_short %} to acce } ``` + For {% data variables.product.prodname_github_app %}, you can add the following example: + + ```javascript copy + { + "mcpServers": { + "github-wider-access": { + "type": "stdio", + "command": "docker", + "args": [ + "run", "--rm", "-i", + "-e", "GITHUB_APP_ID", + "-e", "GITHUB_APP_INSTALLATION_ID", + "-e", "GITHUB_APP_PRIVATE_KEY", + "-e", "GITHUB_READ_ONLY", + "-e", "GITHUB_TOOLSETS", + "ghcr.io/github/github-mcp-server" + ], + "env": { + "GITHUB_APP_ID": "$COPILOT_MCP_GITHUB_APP_ID", + "GITHUB_APP_INSTALLATION_ID": "$COPILOT_MCP_GITHUB_APP_INSTALLATION_ID", + "GITHUB_APP_PRIVATE_KEY": "$COPILOT_MCP_GITHUB_APP_PRIVATE_KEY", + "GITHUB_READ_ONLY": "true", + "GITHUB_TOOLSETS": "repos,pull_requests" + }, + "tools": ["*"] + } + } + } + ``` + + For more information on the {% data variables.product.github %} MCP server with {% data variables.product.prodname_github_app %}, refer to [GitHub App authentication](https://github.com/github/github-mcp-server/blob/main/docs/github-app-auth.md). + For more information on toolsets, refer to the [README](https://github.com/github/github-mcp-server?tab=readme-ov-file#available-toolsets) in the {% data variables.product.github %} Remote MCP Server documentation. 1. Click **Save MCP configuration**. -1. Add an Agents secret called `COPILOT_MCP_GITHUB_PERSONAL_ACCESS_TOKEN` with your {% data variables.product.pat_generic %} as the value. You can configure this at either the organization or repository level. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables). +1. Add your Agents secrets and variables. You can configure these at either the organization or repository level. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables). + + For {% data variables.product.pat_generic %}, add a secret called `COPILOT_MCP_GITHUB_PERSONAL_ACCESS_TOKEN` with your {% data variables.product.pat_generic %} as the value. We recommend using a {% data variables.product.pat_v2 %} so you can limit the token's access to read-only permissions on specific repositories. For more information on {% data variables.product.pat_generic_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). + + For {% data variables.product.prodname_github_app %}, your Agents secrets and variables must be prefixed with `COPILOT_MCP_`. For example, add a variable called `COPILOT_MCP_GITHUB_APP_ID` with your {% data variables.product.prodname_github_app %} ID as the value, a variable called `COPILOT_MCP_GITHUB_APP_INSTALLATION_ID` with your {% data variables.product.prodname_github_app %} installation ID as the value, and a secret called `COPILOT_MCP_GITHUB_APP_PRIVATE_KEY` with your {% data variables.product.prodname_github_app %} private key as the value. + +1. If you see a firewall warning for `api.github.com` when using the {% data variables.product.github %} MCP server, add `api.github.com` to the custom allowlist. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/customize-the-firewall). For information on using the {% data variables.product.github %} MCP server in other environments, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server). diff --git a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-the-firewall.md b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-the-firewall.md index fb85b596b6e3..1cef5f168f55 100644 --- a/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-the-firewall.md +++ b/content/copilot/how-tos/copilot-on-github/customize-copilot/customize-the-firewall.md @@ -40,7 +40,7 @@ If {% data variables.product.prodname_copilot_short %} tries to make a request w The agent firewall has important limitations that affect its security coverage. -* **Only applies to processes started by the agent**: The firewall only applies to processes started by the agent via its Bash tool. It does not apply to Model Context Protocol (MCP) servers or processes started in configured {% data variables.product.prodname_copilot_short %} setup steps. +* **Only applies to processes started by the agent**: The firewall only applies to processes started by the agent via its Bash tool. It does not apply directly to Model Context Protocol (MCP) server processes or processes started in configured {% data variables.product.prodname_copilot_short %} setup steps. Other agent processes can still make network requests while an MCP server is in use, and these requests are subject to the firewall. * **Only applies within the {% data variables.product.prodname_actions %} appliance**: The firewall only operates within the {% data variables.product.prodname_actions %} appliance environment. It does not apply to processes running outside of this environment. * **Bypass potential**: Sophisticated attacks may bypass the firewall, potentially allowing unauthorized network access and data exfiltration. diff --git a/content/copilot/how-tos/set-up/install-copilot-extension.md b/content/copilot/how-tos/set-up/install-copilot-extension.md index 1e871e5e8240..e5e1fe7968e9 100644 --- a/content/copilot/how-tos/set-up/install-copilot-extension.md +++ b/content/copilot/how-tos/set-up/install-copilot-extension.md @@ -11,13 +11,13 @@ redirect_from: - /copilot/how-tos/personal-settings/installing-the-github-copilot-extension-in-your-environment - /copilot/how-tos/set-up/installing-the-github-copilot-extension-in-your-environment contentType: how-tos -category: +category: - Configure Copilot --- ## Prerequisite -To use {% data variables.product.prodname_copilot_short %} in your IDE, you need either limited access through {% data variables.copilot.copilot_free_short %} or a paid {% data variables.product.prodname_copilot_short %} plan for full access. For more information about how to get access and choose the right plan, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +To use {% data variables.product.prodname_copilot_short %} in your IDE, you need either limited access through {% data variables.copilot.copilot_free_short %} or a paid {% data variables.product.prodname_copilot_short %} plan for full access. For more information about how to get access and choose the right plan, see [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). {% azure_data_studio %} @@ -29,7 +29,7 @@ To see instructions for other popular coding environments, use the tool switcher ## Installing the {% data variables.product.prodname_copilot %} extension in Azure Data Studio -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). 1. Make sure you have a compatible version of Azure Data Studio. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. See the [Azure Data Studio download page](https://docs.microsoft.com/sql/azure-data-studio/download-azure-data-studio) in the Azure Data Studio documentation. @@ -64,7 +64,7 @@ For information about version compatibility of the {% data variables.product.pro The following procedure will guide you through installation of the {% data variables.product.prodname_copilot %} plugin in IntelliJ IDEA. Steps to install the plugin in another supported IDE may differ. -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). 1. Make sure you have a JetBrains IDE that is compatible with {% data variables.product.prodname_copilot %}. {% data variables.product.prodname_copilot %} is compatible with the following IDEs: @@ -110,7 +110,7 @@ To see instructions for other popular coding environments, use the tool switcher {% data variables.product.prodname_dotcom %} recommends that you install the {% data variables.product.prodname_copilot %} plugin with Vim/Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install `github/copilot.vim`. For more information, see the [copilot.vim repository](https://github.com/github/copilot.vim). -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). 1. Make sure you have a compatible version of Vim/Neovim installed. To use {% data variables.product.prodname_copilot %} in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above. See the [Vim](https://vimhelp.org/) / [Neovim documentation](https://neovim.io/doc/) and the [Node.js website](https://nodejs.org/en/). @@ -164,7 +164,7 @@ The following instructions are for versions 2022 17.8 and 2022 17.9 of {% data v ## Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vs %} -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). 1. Make sure you have a compatible version of {% data variables.product.prodname_vs %} installed. {% data reusables.copilot.visual-studio-version %} @@ -208,7 +208,7 @@ To use {% data variables.product.prodname_copilot %} for Xcode you must have Xco ## Installing the {% data variables.product.prodname_copilot %} extension for Xcode -1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). 1. Make sure you have a compatible version of Xcode installed. To use {% data variables.product.prodname_copilot %} for Xcode you must have Xcode version 8.0 or above and macOS Monterey (12.0) or above. See [Xcode](https://developer.apple.com/xcode/) on the Apple Developer site. 1. Download the latest version of the {% data variables.product.prodname_copilot %} for Xcode extension from the [`github/CopilotForXcode` repository](https://github.com/github/CopilotForXcode/releases/latest/download/GitHubCopilotForXcode.dmg?ref_product=copilot&ref_type=engagement&ref_style=text) and install it. A background item will be added for the application to be able to start itself when Xcode starts. 1. Open the **{% data variables.product.prodname_copilot %} for Xcode** application from the Applications folder and step through the on-screen instructions for setting up the extension. diff --git a/content/copilot/how-tos/set-up/set-up-for-self.md b/content/copilot/how-tos/set-up/set-up-for-self.md index 2357c43ade78..afb6c10a54a9 100644 --- a/content/copilot/how-tos/set-up/set-up-for-self.md +++ b/content/copilot/how-tos/set-up/set-up-for-self.md @@ -42,7 +42,7 @@ If you want to use {% data variables.product.prodname_copilot_short %} in the co ## 4. Use {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %} -If you want to chat with {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %}, connect {% data variables.product.prodname_copilot_short %} with Terminal Chat in {% data variables.product.prodname_windows_terminal %} Canary. See [AUTOTITLE](/copilot/get-started/quickstart?tool=windowsterminal). +If you want to chat with {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %}, connect {% data variables.product.prodname_copilot_short %} with Terminal Chat in {% data variables.product.prodname_windows_terminal %} Canary. See [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide). ## 5. Set up networking (if necessary) diff --git a/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md b/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md index 9ff7d1461170..a98e31b0030f 100644 --- a/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md +++ b/content/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md @@ -24,7 +24,7 @@ If {% data variables.product.prodname_copilot %} stops working, check {% data va ## Unable to use the {% data variables.product.prodname_copilot %} extension in the IDE -We recommend you follow the quickstart guide for {% data variables.product.prodname_copilot %} while setting up {% data variables.product.prodname_copilot %} on your machine. For more information, see [AUTOTITLE](/copilot/get-started/quickstart). +We recommend you follow the quickstart guide for {% data variables.product.prodname_copilot %} while setting up {% data variables.product.prodname_copilot %} on your machine. For more information, see [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide). The {% data variables.product.prodname_copilot %} extension is frequently updated to fix bugs and add new features. It's important to keep your extension up to date because older clients cannot communicate with the {% data variables.product.prodname_copilot %} servers. Update your {% data variables.product.prodname_copilot %} extension on all the machines you have it installed. diff --git a/content/copilot/index.md b/content/copilot/index.md index 0caf34eccd6d..a9d80ebfa634 100644 --- a/content/copilot/index.md +++ b/content/copilot/index.md @@ -6,8 +6,8 @@ redirect_from: - /github/copilot - /copilot/using-github-copilot/using-github-copilot-for-pull-requests/using-copilot-to-help-you-work-on-a-pull-request introLinks: - overview: /copilot/get-started/what-is-github-copilot - quickstart: /copilot/get-started/quickstart + overview: /copilot/get-started/about-github-copilot + quickstart: /copilot/get-started/quickstart-for-using-github-copilot-on-github-com layout: discovery-landing heroImage: /assets/images/banner-images/hero-6 versions: diff --git a/content/copilot/reference/ai-models/supported-models.md b/content/copilot/reference/ai-models/supported-models.md index 7fce5e8bdc9f..77e7b430c35b 100644 --- a/content/copilot/reference/ai-models/supported-models.md +++ b/content/copilot/reference/ai-models/supported-models.md @@ -221,6 +221,6 @@ The following table lists AI models that are retired or scheduled for retirement ## Next steps -* To get up and running with {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/get-started/quickstart). +* To get up and running with {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-on-github-com) and [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-in-your-ide) . * To configure which models are available to you, see [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/configure-access-to-ai-models). * To learn more about Responsible Use and Responsible AI, see [{% data variables.product.prodname_copilot_short %} Trust Center](https://copilot.github.trust.page/) and [AUTOTITLE](/copilot/responsible-use). diff --git a/content/copilot/reference/copilot-cli-reference/cli-command-reference.md b/content/copilot/reference/copilot-cli-reference/cli-command-reference.md index 67c5488643bc..2826af53253d 100644 --- a/content/copilot/reference/copilot-cli-reference/cli-command-reference.md +++ b/content/copilot/reference/copilot-cli-reference/cli-command-reference.md @@ -504,20 +504,22 @@ These are the slash commands you can use from within an interactive CLI session. | `/tuikit [colors\|icons\|select\|tabbar]` | Preview TUIkit design-system components and color tokens. | | `/undo`, `/rewind` | Open the rewind picker to roll the session back to an earlier user turn. Choose between: **Conversation only** (roll back the conversation, leaving files as they are) or **Conversation + files** (also restore the files {% data variables.product.prodname_copilot_short %} changed in that turn, and later discarded turns, to their pre-change contents, skipping any you have since edited yourself). File changes are tracked per turn across editing tools, shell commands, and sub-agents, so Git is not required. | | `/update`, `/upgrade` | Update the CLI to the latest version. | -| `/usage` | Display session usage metrics and statistics, including per-model token totals. | +| `/usage` | Display session usage metrics and statistics, including per-model token totals. For token-based-billing accounts, each model's row also shows its own {% data variables.product.prodname_ai_credit_singular %} consumption (for example, `1 AIC`). Billed models with no token counts show credits only. | | `/user [show\|list\|switch]` | Manage the current {% data variables.product.github %} user. | | `/version` | Display version information and check for updates. | | `/vim` | Toggle Vim mode for the input composer, enabling Vim-style modal editing: motions (for example, `hjkl`, `w`, `b`, `e`, `0`, `$`, `gg`, `G`), character search (`f`/`F`/`t`/`T`/`;`/`,`), insert commands (`i`/`a`/`o`), edit commands (`r`/`~`/`J`/`x`/`D`/`C`), operators (`d`/`c`/`y`), yank and put (`y`/`p`/`P`), repeat (`.`), undo and redo (`u`/Ctrl+R), counts, and Esc to return to normal mode. Also configurable with the `editorMode` setting. See [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-config-dir-reference#user-settings-copilotsettingsjson). | | `/voice [on\|off\|models\|devices]` | Toggle voice mode, browse available voice models, or choose the input device (microphone). | | `/fork [NAME]`, `/branch [NAME]` | Fork the current session into a new session, optionally with a name. | -| `/worktree [branch\|task]` | Create a new Git worktree and switch to it, leaving uncommitted changes behind in the current worktree. Pass a branch name, a task description (multiline supported, used as the opening prompt in the new worktree), or omit the argument to auto-generate a branch name from the conversation. By default, branches off the current checkout (`HEAD`); set the `worktreeBaseRef` setting to `"defaultBranch"` to branch off the remote default branch instead. See [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-config-dir-reference#user-settings-copilotsettingsjson). Requires a Git repository. {% data reusables.copilot.experimental %} | -| `/worktree new [PROMPT]` | Start a new conversation in a new Git worktree, leaving the current conversation and its working directory unchanged. Optionally provide the first prompt. `new` is reserved as the subcommand keyword and can't be used as a literal branch name. Follows the same `worktreeBaseRef` setting as `/worktree`. {% data reusables.copilot.experimental %} | -| `/move [branch\|task]` | Move uncommitted changes into a new Git worktree and switch to it. Pass a branch name, a task description (multiline supported, used as the opening prompt in the new worktree), or omit the argument to auto-generate a branch name from the conversation. Requires a Git repository. {% data reusables.copilot.experimental %} | +| `/worktree [branch\|task]` | Create a new Git worktree and switch to it, leaving uncommitted changes behind in the current worktree. Pass a branch name, a task description (multiline supported, used as the opening prompt in the new worktree), or omit the argument to auto-generate a branch name from the conversation. By default, branches off the current checkout (`HEAD`); set the `worktreeBaseRef` setting to `"defaultBranch"` to branch off the remote default branch instead. See [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-config-dir-reference#user-settings-copilotsettingsjson). Requires a Git repository. | +| `/worktree new [PROMPT]` | Start a new conversation in a new Git worktree, leaving the current conversation and its working directory unchanged. Optionally provide the first prompt. `new` is reserved as the subcommand keyword and can't be used as a literal branch name. Follows the same `worktreeBaseRef` setting as `/worktree`. | +| `/move [branch\|task]` | Move uncommitted changes into a new Git worktree and switch to it. Pass a branch name, a task description (multiline supported, used as the opening prompt in the new worktree), or omit the argument to auto-generate a branch name from the conversation. Requires a Git repository. | For a complete list of available slash commands enter `/help` in the CLI's interactive interface. In the schedule manager opened by a bare `/every` or `/after`, use ↑/↓ to select an entry and `x` to remove it. Schedules can only be added from the prompt input using `/every` or `/after` with arguments—the dialog itself is read-and-remove only. +The footer shows an "N scheduled" indicator by default whenever the session has active schedules, even if `/every` and `/after` are not enabled for you. + `/plugin` flags an installed plugin or marketplace when a newer version is available upstream, and offers an **Update** action from the dashboard. `/mcp list`/`ls` and `/plugin list`/`ls` (including bare `/plugin`) are read-only and can run while the agent is busy processing a turn. All other `/mcp` and `/plugin` subcommands are blocked until the turn finishes. @@ -532,7 +534,7 @@ In the schedule manager opened by a bare `/every` or `/after`, use ↑↑↑.worktrees/` and start the session inside it. `NAME` is optional—omit it to auto-generate a branch name. By default, branches off the current checkout (`HEAD`); set the `worktreeBaseRef` setting to `"defaultBranch"` to branch off the remote default branch instead. Conflicts with `--resume`, `--continue`, and `--connect`. {% data reusables.copilot.experimental %} | +| `-w`, `--worktree[=NAME]` | Create or reuse an isolated Git worktree under `.worktrees/` and start the session inside it. `NAME` is optional—omit it to auto-generate a branch name. By default, branches off the current checkout (`HEAD`); set the `worktreeBaseRef` setting to `"defaultBranch"` to branch off the remote default branch instead. Conflicts with `--resume`, `--continue`, and `--connect`. | | `--yolo` | Enable all permissions (equivalent to `--allow-all`). | For a complete list of commands and options, run `copilot help`. @@ -622,6 +625,8 @@ Plan-then-autopilot lets a session start in plan mode and automatically continue An enterprise-managed policy can enforce OS-level shell sandboxing as a minimum floor. In other words, even if you pass `--no-sandbox`, the policy can still force sandboxing on. This is a policy override, not a failure of the flag itself. By contrast, `--sandbox` is unaffected because it only turns sandboxing on and never removes it. If the effective policy permits sandbox bypass, you can explicitly disable sandboxing for the rest of the current session while responding to an active bypass permission prompt. +When a managed floor forces sandboxing on with an effective `sandbox.allowBypass` of `true` (the default when a policy sets only `sandbox.enabled` to `true`), run `/sandbox disable` to opt out of the sandbox for the rest of the current session—no bypass prompt is required first. The opt-out is session-only: nothing is saved to `settings.json`, a new session starts sandboxed again, and `/sandbox enable` restores sandboxing immediately without waiting for a new session. If `allowBypass` is `false`, `/sandbox disable` refuses with a message that sandboxing is enforced by the managed policy and can't be disabled. + When a managed policy overrides your setting, the CLI shows a warning in the interactive timeline (or on stderr when using `-p`) so it is clear that the behavior comes from policy enforcement rather than the option failing to work. Contact your administrator if you need the policy changed. The `/sandbox` command is also registered whenever a managed policy forces sandboxing on, even without experimental features enabled, so you can still inspect the effective policy and status while the floor applies. {% data reusables.copilot.experimental %} Adding the managed `sandbox.failIfUnavailable` setting set to `true`, alongside `sandbox.enabled` set to `true`, makes the sandbox mandatory when it cannot be established. Instead of falling back to running commands unsandboxed, {% data variables.product.prodname_copilot_short %} blocks model and tool execution if the policy can't be validated, compiled, or enforced by a usable sandbox backend. See [AUTOTITLE](/copilot/reference/enterprise-administrators/enterprise-managed-settings#sandbox). @@ -761,6 +766,7 @@ copilot --deny-tool='write(secret.txt)' | `COPILOT_MODEL` | Set the AI model. | | `COPILOT_PLAN_THEN_AUTOPILOT` | Set to `1`, `true`, `yes`, or `on` to request plan-then-autopilot (equivalent to `--plan --mode autopilot`) for harnesses that can only inject environment variables. Ignored, with a warning, when an explicit `--mode`, `--autopilot`, or `--plan` option is passed. See [Plan-then-autopilot](#plan-then-autopilot). | | `COPILOT_PROMPT_FRAME` | Set to `1` to enable the decorative UI frame around the input prompt, or `0` to disable it. Overrides the `PROMPT_FRAME` experimental feature flag for the current session. | +| `COPILOT_PROVIDER_API_KEY_COMMAND` | Shell command that prints a fresh bring-your-own-key (BYOK) API key before each provider request. Takes precedence over the `COPILOT_PROVIDER_API_KEY` environment variable. Its output replaces the matching credential header even if a custom header set via `COPILOT_PROVIDER_HEADERS` would otherwise collide. | | `COPILOT_PROVIDERS_CONFIG` | Path to a JSON file that defines a bring-your-own-key (BYOK) provider and model registry, as an object with `providers` and `models` keys. Default: `/providers.json`. When this file declares any provider or model, it takes precedence over the legacy `COPILOT_PROVIDER_*` environment variables. See [`providers.json`](/copilot/reference/copilot-cli-reference/cli-config-dir-reference#providersjson). | | `COPILOT_SKILLS_DIRS` | Comma-separated list of additional directories for skills. | | `PLUGINS_DASHBOARD` | Set to `false` to disable the plugins dashboard opened by bare `/plugin`, `/mcp`, and `/skills`, and to disable the non-interactive `copilot plugin`/`copilot plugins` commands. | @@ -1412,7 +1418,11 @@ A sandbox bypass prompt also offers a **Yes, and disable the sandbox for the res A detached (backgrounded) command can't be sandboxed at all, since the sandbox can't wrap a process that outlives the tool call. When the **Allow sandbox bypass** setting is on, this prompts for approval before the command starts, instead of being refused outright. Approving runs the command unsandboxed from the start. -On Windows hosts whose sandbox policy supports denial capture, a blocked interactive shell command escalates in a single step instead of jumping straight to a full bypass. Approving re-runs the command with file and process restrictions set to record instead of block (the network policy still applies), then falls back to the disclosed full bypass only if the command is still blocked. Only one prompt is shown for the entire escalation. +On Windows hosts whose sandbox policy supports denial capture, a blocked interactive shell command escalates in a single step instead of jumping straight to a full bypass. Approving re-runs the command with file and process restrictions set to record instead of block (the network policy still applies), then falls back to the disclosed full bypass only if the command is still blocked. Only one prompt is shown for the entire escalation. A denied loopback or local-network socket (for example, binding or connecting to `127.0.0.1`) also reaches this same escalation instead of failing silently. The retry result is labeled "sandbox relaxed" when network policy is still enforced, or "sandbox bypassed" when fully unsandboxed. If the retry still fails, the message explains that host-level permissions still apply. + +A command that fails with an `EPERM` or `EACCES` diagnostic naming a sandbox-blocked path now offers to run outside the sandbox, even when the command line itself never named that path. + +When a denial is caused by a symlink whose target escapes what the sandbox policy grants, the denial explains that the granted path's link points outside the grant and names the real target, so you know exactly which path to add to your sandbox policy. For more information, see [AUTOTITLE](/copilot/how-tos/cloud-and-local-sandboxes/configuring-local-sandbox-settings#allowing-sandbox-bypass). @@ -1615,6 +1625,7 @@ One span per tool call. Span kind: `INTERNAL`. | `gen_ai.invoke_agent.duration` | Histogram | s | End-to-end duration of one agent invocation | | `gen_ai.invoke_agent.inference_calls` | Histogram | `{inference_call}` | Number of model calls made during one agent invocation, counted at provider dispatch (failed and partial calls included; requests blocked before dispatch excluded). Dimension: `gen_ai.agent.name`. | | `gen_ai.invoke_agent.tool_calls` | Histogram | `{tool_call}` | Number of client-side tool calls made during one agent invocation (failed and partial calls included; synthetic CLI tool lifecycles and provider-executed server-side tools excluded). Dimension: `gen_ai.agent.name`. | +| `gen_ai.invoke_workflow.duration` | Histogram | s | End-to-end duration of a GenAI workflow (for example, a fleet mode run orchestrating parallel subagents). | #### Vendor-specific metrics diff --git a/content/copilot/reference/copilot-cli-reference/cli-config-dir-reference.md b/content/copilot/reference/copilot-cli-reference/cli-config-dir-reference.md index 7f9c2df7230b..9c5d5e334d12 100644 --- a/content/copilot/reference/copilot-cli-reference/cli-config-dir-reference.md +++ b/content/copilot/reference/copilot-cli-reference/cli-config-dir-reference.md @@ -498,6 +498,8 @@ These settings apply across all your sessions and repositories. You can use the | `sandbox.auth.gh` | `boolean` | `true` | Inject {% data variables.product.prodname_cli %} (`gh`) credentials into the sandbox so commands running inside it can authenticate with the {% data variables.product.prodname_cli %}. Set to `false` to opt out. Renamed from `sandbox.ghAuth`; the old key has no migration and is ignored wherever it still appears. | | `sandbox.userPolicy.network.allowLocalNetwork` | `boolean` | `true` | Allow sandboxed commands to reach local network addresses (for example, local dev servers). Set to `false` to opt out. | | `sandbox.userPolicy.network.proxy` | `object` | unset | Route sandboxed network traffic through an HTTP proxy. Fields: `url` (required), `username` (optional), `password` (optional). Configure it from the `/sandbox` dialog's **Network** tab, which masks the password field. The password itself is stored in the OS keychain rather than in `settings.json`, so it isn't editable via `/settings`. Enforcement differs by platform: on macOS the proxy is cooperative—{% data variables.copilot.copilot_cli_short %} sets `HTTP_PROXY`, `HTTPS_PROXY`, and `ALL_PROXY` in the sandbox, so only programs that honor those variables use it; on Linux it is strictly enforced through a private network namespace that permits only the proxy endpoint (the proxy must have an IPv4 address and must not embed credentials); on Windows the proxy is not supported, so a policy that sets it is rejected and the sandboxed command fails with an error. | +| `sandbox.userPolicy.network.allowedHosts` | `string[]` | `[]` | Hosts a sandboxed command is allowed to reach. Entries are exact hostnames, IP addresses, or `*.example.com` for strict subdomain matches (`*` matches every host). A non-empty list blocks any host that doesn't match. Configure from the `/sandbox` dialog's **Network** tab under **Host rules**. | +| `sandbox.userPolicy.network.blockedHosts` | `string[]` | `[]` | Hosts a sandboxed command is denied from reaching, matched the same way as `allowedHosts`. `blockedHosts` always takes precedence over a matching `allowedHosts` entry, and denying a domain also denies its subdomains. Configure from the `/sandbox` dialog's **Network** tab under **Host rules**. | | `sandbox.userPolicy.deniedPaths` | `string[]` | `[]` | Paths that sandboxed commands are denied access to. On Windows, the ProcessContainer (BaseContainer) backend cannot enforce per-path deny rules, so a policy that sets `deniedPaths` is rejected and the sandboxed command fails with an error—remove the denied paths, or use macOS or Linux, to run that policy. | | `sandbox.userPolicy.seatbelt.keychainAccess` | `boolean` | `false` | macOS only. Grant sandboxed commands access to the system keychain. Can also be toggled from the `/sandbox` dialog. | | `screenReader` | `boolean` | `false` | Enable screen reader optimizations. | @@ -529,7 +531,9 @@ These settings apply across all your sessions and repositories. You can use the > [!TIP] > Run `copilot help sandbox` for the full sandbox reference, including supported hosts and all `sandbox` settings keys. -The `/sandbox` dialog groups `git`, `gh`, and keychain access under a dedicated **Auth** tab, and shows the `settings.json` path where the current sandbox configuration is stored. Press Ctrl+E in the `/sandbox` dialog to save any pending changes and open `settings.json` in your editor (`COPILOT_EDITOR`, `VISUAL`, or `EDITOR`), matching the same shortcut in `/settings`. The dialog reloads its state from disk after you edit and save the file. +The `/sandbox` dialog groups `git`, `gh`, and keychain access under a dedicated **Auth** tab, and shows the `settings.json` path where the current sandbox configuration is stored. On the **Filesystem** tab, the configured path list is summarized by permission (for example, `2 read/write, 1 read-only`) behind a **Paths** row. Press Enter on that row to open the full list, which takes over the cursor and tab bar until you press Esc. Configured paths are displayed as absolute paths rather than `./`-relative or `~`-shortened forms. Typing `~/path` when adding a path still expands it to your home directory. Press Ctrl+E in the `/sandbox` dialog to save any pending changes and open `settings.json` in your editor (`COPILOT_EDITOR`, `VISUAL`, or `EDITOR`), matching the same shortcut in `/settings`. The dialog reloads its state from disk after you edit and save the file. + +`sandbox.userPolicy.network.allowedHosts` and `sandbox.userPolicy.network.blockedHosts` run through a built-in local proxy that enforces them strictly on every platform, unlike the cooperative `sandbox.userPolicy.network.proxy` setting on Linux and macOS. When both are configured, the local proxy uses `sandbox.userPolicy.network.proxy` as its upstream, so proxy credentials never reach the sandboxed child process. Sandboxing is powered by [Microsoft eXecution Container (MXC)](https://github.com/microsoft/mxc), which provides platform-specific containment backends. {% data variables.copilot.copilot_cli_short %} uses Seatbelt on macOS, Bubblewrap on Linux, and ProcessContainer on Windows. @@ -656,20 +660,14 @@ Only the following keys are supported in MDM managed settings. | `telemetry` | Push baseline OpenTelemetry export configuration: `enabled`, `endpoint`, `protocol`, `headers`, `resourceAttributes`, `captureContent`, `lockCaptureContent`, and `serviceName`. See [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference#opentelemetry-monitoring). | > [!NOTE] -> `policyHelper.path` accepts an absolute path, a home-relative path (`~/...`), or a bare program name resolved from `PATH`. Other relative forms are rejected. The registration is accepted and validated, but the runtime doesn't yet invoke the helper—helper execution ships in a future release. - -> [!NOTE] -> When `remoteControl.mode` is `"requireSSO"`, list the allowed organizations in `remoteControl.githubDotComOrganizations`. The client must be SSO-authorized for at least one listed {% data variables.product.prodname_dotcom_the_website %} organization—it no longer needs to be authorized for all of them. - -> [!NOTE] -> Set `permissions.disableBypassPermissionsMode` to `"disable"` in MDM managed settings to enforce the restriction at the device level. Account switches cannot override this policy. Set it to `"allow-auto-only"` to block full allow-all escalation while still permitting `/permissions assisted` (LLM-assisted permission approval). If an unrecognized value is set, the CLI logs the issue and enforces `"disable"` as a fail-closed default, so a malformed managed policy still restricts the allow-all options instead of silently allowing them. See [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference#restricting-the---allow-all-options). - -> [!NOTE] -> Most managed keys lock the entire row: a local edit is silently overridden by the managed value on the next load. `enabledPlugins` and `extraKnownMarketplaces` are the exception—the managed layer merges these maps with your own entries field-by-field instead of replacing them outright. This means the lock applies **per entry**, not to the whole key: a plugin or marketplace pinned by a managed policy can't be re-enabled, disabled, or repointed locally, but other entries in the same map remain fully user-controlled. +> * `policyHelper.path` accepts an absolute path, a home-relative path (`~/...`), or a bare program name resolved from `PATH`. Other relative forms are rejected. The registration is accepted and validated, but the runtime doesn't yet invoke the helper—helper execution ships in a future release. +> * When `remoteControl.mode` is `"requireSSO"`, list the allowed organizations in `remoteControl.githubDotComOrganizations`. The client must be SSO-authorized for at least one listed {% data variables.product.prodname_dotcom_the_website %} organization—it no longer needs to be authorized for all of them. +> * Set `permissions.disableBypassPermissionsMode` to `"disable"` in MDM managed settings to enforce the restriction at the device level. Account switches cannot override this policy. Set it to `"allow-auto-only"` to block full allow-all escalation while still permitting `/permissions assisted` (LLM-assisted permission approval). If an unrecognized value is set, the CLI logs the issue and enforces `"disable"` as a fail-closed default, so a malformed managed policy still restricts the allow-all options instead of silently allowing them. See [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference#restricting-the---allow-all-options). +> * Most managed keys lock the entire row: a local edit is silently overridden by the managed value on the next load. `enabledPlugins` and `extraKnownMarketplaces` are the exception—the managed layer merges these maps with your own entries field-by-field instead of replacing them outright. This means the lock applies **per entry**, not to the whole key: a plugin or marketplace pinned by a managed policy can't be re-enabled, disabled, or repointed locally, but other entries in the same map remain fully user-controlled. ### Managed permission rules -Push `deny`, `ask`, and `allow` rule lists under the managed `permissions` key to enforce a permission policy across all users, independent of `permissions.disableBypassPermissionsMode`. +Add `deny`, `ask`, and `allow` rule lists under the managed `permissions` key to enforce a permission policy for everyone. This works whether or not `permissions.disableBypassPermissionsMode` is set. ```json { @@ -691,6 +689,8 @@ Push `deny`, `ask`, and `allow` rule lists under the managed `permissions` key t Rules are combined across managed sources with a fixed precedence: deny always wins, then ask, then allow—matching a `deny` rule blocks the request even if an `allow` rule also matches. `deny` and `ask` are unioned across every managed source (server, MDM). `allow` requires every source that declares an `allow` list to admit the operation—an intersection, not a union. When any of `deny`, `ask`, or `allow` is set, an operation that matches none of them defaults to `ask` rather than falling through silently. +`Edit(...)` and `Write(...)` rules apply to more than the built-in file tools. They also cover files written directly by a shell command. {% data variables.copilot.copilot_cli_short %} recognizes a fixed set of these writes. It covers Bash output redirections (`>`, `>>`, `>|`, `&>`, `&>>`), PowerShell output redirections (`>`, `>>`, `*>`, `*>>`), and a small set of in-place `sed` edits (`sed -i` or `--in-place`, and the BSD forms `-i ''` and `-I ''`). When {% data variables.copilot.copilot_cli_short %} can work out the target file from the command, a matching `deny` rule blocks the write and a matching `ask` rule prompts you first. This applies even when a broad rule like `Shell(*)` would otherwise allow the command. Sometimes the target file cannot be worked out ahead of time, for example when the path comes from a variable. In that case these path rules do not apply, and the command is checked by the normal shell command rules instead. + ## Managed MCP server allow/deny list Administrators can govern MCP servers directly through MDM managed settings, independent of the [enterprise MCP allowlist](/copilot/reference/copilot-cli-reference/cli-command-reference#enterprise-mcp-allowlist). diff --git a/content/copilot/reference/copilot-cli-reference/cli-plugin-reference.md b/content/copilot/reference/copilot-cli-reference/cli-plugin-reference.md index d5c17c556250..dbb7495184be 100644 --- a/content/copilot/reference/copilot-cli-reference/cli-plugin-reference.md +++ b/content/copilot/reference/copilot-cli-reference/cli-plugin-reference.md @@ -210,6 +210,26 @@ These tell the CLI where to find your plugin's components. All are optional. The | `mcpServers`| string \| object | — | Path to an MCP configuration file (e.g., `.mcp.json`), or inline server definitions. | | `lspServers`| string \| object | — | Path to an LSP configuration file, or inline server definitions. | +#### Plugin-shipped agent MCP servers + +An agent bundled inside a plugin can declare its own `mcp-servers` in its frontmatter, scoping an MCP server to just that agent instead of exposing it through the plugin's shared `mcpServers` configuration. Within that `mcp-servers` block, `${PLUGIN_ROOT}` (or its `${CLAUDE_PLUGIN_ROOT}`/`${COPILOT_PLUGIN_ROOT}` aliases) expands to the plugin's root directory, so the server's `command` or `args` can point at a script bundled with the plugin: + +```markdown +--- +name: Plugin Linter +description: Runs the plugin's bundled linter via its own MCP server +mcp-servers: + plugin-linter: + command: node + args: ["${PLUGIN_ROOT}/tools/serve.js"] + tools: ["*"] +--- + +You are a linting specialist for this plugin's bundled rules. +``` + +This substitution only applies to `mcp-servers` in a plugin-shipped agent's own frontmatter—it doesn't extend to `${PLUGIN_DATA}` or to the server's environment variables. Workspace and user agents have no plugin root, so their frontmatter is left unchanged. + ### LSP server configuration To include LSP (Language Server Protocol) servers in a plugin, create a `lsp-config/servers.json` file in the plugin directory, or specify a path or inline object using the `lspServers` field in `plugin.json`. diff --git a/content/copilot/reference/copilot-cli-reference/cli-programmatic-reference.md b/content/copilot/reference/copilot-cli-reference/cli-programmatic-reference.md index f5e2adeeea78..843940fe4b34 100644 --- a/content/copilot/reference/copilot-cli-reference/cli-programmatic-reference.md +++ b/content/copilot/reference/copilot-cli-reference/cli-programmatic-reference.md @@ -38,9 +38,15 @@ There are a number of command-line options that are particularly useful when run | `--allow-all-urls` | Allow access to all URLs without explicit permission for each URL. | | `--allow-tool=TOOL ...` | Selectively grant permission for a specific tool. For multiple tools, use a quoted, comma-separated list. | | `--allow-url=URL ...` | Allow the agent to fetch a specific URL or domain. Useful when a workflow needs web access to known endpoints. For multiple URLs, use a quoted, comma-separated list. | +| `--attachment=PATH ...` | Attach a file (image or native document) to the initial prompt. Only valid in non-interactive mode. Can be used multiple times to attach multiple files. | +| `--available-tools=TOOL ...` | Restrict the model to only the tools you list; all other tools are unavailable. Useful for tightly scoping what the agent can do in an automated workflow. For multiple tools, use a quoted, comma-separated list. | | `--deny-tool=TOOL ...` | Deny a specific tool. Useful for restricting what the agent can do in a locked-down workflow. For multiple tools, use a quoted, comma-separated list. | +| `--deny-url=URL ...` | Deny access to a specific URL or domain. Takes precedence over `--allow-url`. For multiple URLs, use a quoted, comma-separated list. | +| `--excluded-tools=TOOL ...` | Remove specific tools from those available to the model. For multiple tools, use a quoted, comma-separated list. | +| `--fleet` | Run the prompt in fleet mode, so {% data variables.product.prodname_copilot_short %} uses parallel subagents to work on separate parts of the task. Combine with `-p` for non-interactive automation, `-i` for an interactive session, or a piped prompt. Not supported in ACP server mode. See [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion). | | `--model=MODEL` | Choose the AI model (for example, `gpt-5.4` or `claude-haiku-4.5`). Useful for pinning a model in reproducible workflows. See [Choosing a model](#choosing-a-model) below. | | `--no-ask-user` | Prevent the agent from pausing to seek additional user input. | +| `--output-format=FORMAT` | Set the output format: `text` (the default) or `json`. With `json`, the CLI emits JSONL (one JSON object per line), which is convenient for parsing the agent's output in scripts. | | `--secret-env-vars=VAR ...` | An environment variable whose value you want redacted in output. For multiple variables, use a quoted, comma-separated list. Essential for preventing secrets being exposed in logs. The values in the `GITHUB_TOKEN` and `COPILOT_GITHUB_TOKEN` environment variables are redacted by default. | | `--share=PATH` | Export the session transcript to a markdown file after non-interactive completion (defaults to `./copilot-session-.md`). Useful for auditing or archiving what the agent did. Note that session transcripts may contain sensitive information. | | `--share-gist` | Publish the session transcript as a secret GitHub gist after completion. Convenient for sharing results from CI. Note that session transcripts may contain sensitive information. | @@ -88,6 +94,7 @@ You can use environment variables to configure various aspects of the CLI's beha | `COPILOT_ALLOW_ALL` | Set to `true` for full permissions | | `COPILOT_MODEL` | Set the model (for example, `gpt-5.4`, `claude-haiku-4.5`) | | `COPILOT_HOME` | Set the directory for the CLI configuration file (`~/.copilot` by default) | +| `COPILOT_AUTO_UPDATE` | Set to `false` to disable automatic updates. Useful in CI and other automated environments where you want to pin the CLI version. | | `COPILOT_GITHUB_TOKEN`| Authentication token (highest precedence) | | `GH_TOKEN` | Authentication token (second precedence) | | `GITHUB_TOKEN` | Authentication token (third precedence) | diff --git a/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/resources-for-approval.md b/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/resources-for-approval.md index 4fa1371ee637..2f466a7cf270 100644 --- a/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/resources-for-approval.md +++ b/content/copilot/tutorials/roll-out-at-scale/govern-at-scale/resources-for-approval.md @@ -41,7 +41,7 @@ Compliance teams may also want to know about the administrative features availab * Audit logs for monitoring changes to access and settings * The ability to exclude sensitive content from {% data variables.product.prodname_copilot_short %}'s view -For an overview of these features, see [AUTOTITLE](/copilot/get-started/features#features-for-administrators). +For guidance on managing {% data variables.product.prodname_copilot_short %} for your team, including configuring settings and monitoring usage, see [AUTOTITLE](/copilot/how-tos/administer-copilot). ### For new {% data variables.product.prodname_enterprise %} customers diff --git a/content/get-started/learning-about-github/githubs-plans.md b/content/get-started/learning-about-github/githubs-plans.md index d143f88529f4..40d7b89bad9f 100644 --- a/content/get-started/learning-about-github/githubs-plans.md +++ b/content/get-started/learning-about-github/githubs-plans.md @@ -88,6 +88,10 @@ In addition to the features available with {% data variables.product.prodname_fr For more information, see [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security). +{% ifversion fpt or ghec %} +* The option to purchase {% data variables.product.prodname_code_quality %}, which helps teams find and fix code quality and coverage issues. For more information, see [AUTOTITLE](/code-security/concepts/code-quality/code-quality). +{% endif %} + * Advanced tools and insights in private repositories: * Required pull request reviewers * Multiple pull request reviewers diff --git a/content/migrations/ado/key-differences-between-azure-devops-and-github.md b/content/migrations/ado/key-differences-between-azure-devops-and-github.md index e0f8893781f5..e613f131ea41 100644 --- a/content/migrations/ado/key-differences-between-azure-devops-and-github.md +++ b/content/migrations/ado/key-differences-between-azure-devops-and-github.md @@ -89,4 +89,4 @@ For more information, see [AUTOTITLE](/packages/learn-github-packages/introducti Hosting your repositories on {% data variables.product.github %} unlocks the full power of {% data variables.product.prodname_copilot_short %}. Your codebase provides {% data variables.product.prodname_copilot_short %} with all the context it needs to answer questions in {% data variables.copilot.copilot_chat_short %}, review and make suggestions in your pull requests, and even make changes on your behalf with {% data variables.copilot.copilot_cloud_agent %}. -See [AUTOTITLE](/copilot/get-started/quickstart). +See [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-on-github-com). diff --git a/content/migrations/elm/prepare-for-your-migration.md b/content/migrations/elm/prepare-for-your-migration.md index 3dbbc6605ec1..fc3d01045717 100644 --- a/content/migrations/elm/prepare-for-your-migration.md +++ b/content/migrations/elm/prepare-for-your-migration.md @@ -15,6 +15,7 @@ contentType: concepts +* `3.22.0` * `3.21.3` * `3.20.5` * `3.19.9` diff --git a/content/pull-requests/concepts/writing-code-for-a-project.md b/content/pull-requests/concepts/writing-code-for-a-project.md index f520d701cc39..2da6d58ab9a8 100644 --- a/content/pull-requests/concepts/writing-code-for-a-project.md +++ b/content/pull-requests/concepts/writing-code-for-a-project.md @@ -15,14 +15,14 @@ When you contribute to a project, you need a safe place to write and refine code Most work starts by creating an isolated copy of the code that you can change freely. -* Use a **branch** when you have write access to a repository. A branch lets you develop a feature, fix a bug, or experiment in a contained area of the repository without affecting other branches. You create a branch from an existing branch, usually the default branch. +* Use a **branch** when you have write access to a repository. A branch lets you develop a feature, fix a bug, or experiment in a contained area of the repository without affecting other branches. You create a branch from an existing branch, usually the default branch. * Use a **fork** when you do not have write access, or when you want full independence from the original project. A fork is a separate repository that shares code and visibility settings with the original "upstream" repository. It has its own branches, issues, and pull requests. With a fork, you can also open pull requests for the upstream repository. A branch is usually the simplest choice when you already collaborate in a shared repository. A fork is often the best choice for open source contributions, where you may not have write access to the upstream repository. ## Checking in work with commits -As you write code, you save small, meaningful groups of changes as **commits**. Each commit records a snapshot of your work along with a message describing what changed, which makes it easier to track history, review changes, and understand how the code evolved. +As you write code, you save small, meaningful groups of changes as **commits**. Each commit records a snapshot of your work along with a message describing what changed, which makes it easier to track history, review changes, and understand how the code evolved. Committing frequently on your branch or fork lets you: @@ -32,7 +32,7 @@ Committing frequently on your branch or fork lets you: ## Proposing changes with pull requests -When your work is ready to share, you open a **pull request** to propose merging your changes into the base branch. A pull request brings together your commits, a description of the change, and the tools reviewers need to discuss and evaluate it before it merges. +When your work is ready to share, you open a **pull request** to propose merging your changes into the base branch. A pull request brings together your commits, a description of the change, and the tools reviewers need to discuss and evaluate it before it merges. You can open a pull request while work is still in progress by creating a draft pull request, which shares your changes without formally requesting review. This is useful when you want early feedback or want to run automated checks against your code. @@ -40,18 +40,18 @@ You can open a pull request while work is still in progress by creating a draft While a pull request is open, the base branch can keep changing as other people merge their work. To keep your changes clean and reduce conflicts, you can: -* Merge or rebase the base branch into your branch frequently so your diff stays focused on what your change introduces. {% data variables.product.github %} shows a three-dot diff by default, which compares your branch against the point where it diverged from the base. +* Merge or rebase the base branch into your branch frequently so your diff stays focused on what your change introduces. {% data variables.product.github %} shows a three-dot diff by default, which compares your branch against the point where it diverged from the base. * Rebase to tidy a messy commit history—reordering, combining, or rewording commits—before you ask for review. -* Resolve merge conflicts when Git cannot automatically combine competing changes. +* Resolve merge conflicts when Git cannot automatically combine competing changes. ## Working within repository controls Experienced contributors work within the guardrails a repository defines. These controls shape where you can push, who must approve your work, and what must pass before it merges. -* **Protected branches and rulesets** can block direct pushes to important branches, require linear history or signed commits, and require status checks or reviews before merging. -* **Code owners** are automatically requested for review when your change touches files they own, so plan for their approval on sensitive areas. +* **Protected branches and rulesets** can block direct pushes to important branches, require linear history or signed commits, and require status checks or reviews before merging. +* **Code owners** are automatically requested for review when your change touches files they own, so plan for their approval on sensitive areas. * **Push rulesets** can apply across a fork network, restricting file paths, sizes, or names in every fork. -* **Pre-receive hooks** let administrators on {% data variables.product.prodname_ghe_server %} enforce policy checks on the server before commits are accepted. +* **Pre-receive hooks** let administrators on {% data variables.product.prodname_ghe_server %} enforce policy checks on the server before commits are accepted. ## An integrated toolchain @@ -60,11 +60,11 @@ Pull requests connect your code to the automation and services that help you wri {% ifversion fpt or ghec %}* **{% data variables.product.prodname_copilot %}** can help you write, debug, and optimize code. {% endif %} * **{% data variables.product.prodname_code_scanning_caps %}** and **{% data variables.product.prodname_dependabot %}** surface security issues and vulnerable dependencies as your changes move through a pull request, so you can apply secure coding practices early. -* **{% data variables.product.prodname_actions %}** can run continuous integration on every push to your pull request, building and testing your changes automatically. +* **{% data variables.product.prodname_actions %}** can run continuous integration on every push to your pull request, building and testing your changes automatically. ## Further reading * [AUTOTITLE](/pull-requests/how-tos/create-pull-requests/creating-a-pull-request) {% ifversion fpt or ghec %} -* [AUTOTITLE](/copilot/get-started/quickstart) +* [AUTOTITLE](/copilot/get-started/quickstart-for-using-github-copilot-on-github-com) {% endif %} diff --git a/content/pull-requests/reference/forks.md b/content/pull-requests/reference/forks.md index 3889d221f96c..f0858468edf5 100644 --- a/content/pull-requests/reference/forks.md +++ b/content/pull-requests/reference/forks.md @@ -105,8 +105,9 @@ Forks are powerful collaboration tools, but they can expose code and history in * Forks have their own permissions separate from the upstream repository. * Owners of an upstream repository can read all forks in the repository network. * Organization owners may have administrative access to forks created in personal namespaces. -* Removing someone's access to the upstream repository does not always delete forks in other organizations. -* Commits can remain accessible in the repository network even after a fork is deleted. +* Organization owners of a repository that has been forked have read permission to forks created in organizations, but do not have the ability to delete the fork or its branches. +* Forks created in another organization will not be deleted when individual access is removed from the upstream repository. +* Commits to any repository in a network can be accessed from any repository in the same network, including the upstream repository, even after a fork is deleted. Before allowing forks for sensitive work, review the permissions and visibility model for your repository or organization. diff --git a/content/rest/copilot/copilot-usage-metrics.md b/content/rest/copilot/copilot-usage-metrics.md index 32600910d522..d831754070bc 100644 --- a/content/rest/copilot/copilot-usage-metrics.md +++ b/content/rest/copilot/copilot-usage-metrics.md @@ -20,4 +20,6 @@ To enable these endpoints, the "{% data variables.product.prodname_copilot_short For more information on the metrics returned by these endpoints, see [AUTOTITLE](/copilot/reference/copilot-usage-metrics). +For help understanding gaps or discrepancies in {% data variables.product.prodname_copilot_short %} usage data, see [AUTOTITLE](/copilot/reference/copilot-usage-metrics/reconciling-usage-metrics). + diff --git a/data/reusables/copilot/cloud-agent/agent-management-intro.md b/data/reusables/copilot/cloud-agent/agent-management-intro.md index 0d83cdc866cd..f0d890245e8c 100644 --- a/data/reusables/copilot/cloud-agent/agent-management-intro.md +++ b/data/reusables/copilot/cloud-agent/agent-management-intro.md @@ -1 +1 @@ -When utilizing {% data variables.product.github %}'s agentic features, you can use the **Agents** tab within a repository that has {% data variables.copilot.copilot_cloud_agent %} enabled to initiate, monitor, and manage agent sessions without leaving your workflow. You can also use the [Agents page](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text) to view and start agent sessions. To learn how to enable {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management). +When utilizing {% data variables.product.github %}'s agentic features, you can use the **Agents** tab within a repository that has {% data variables.copilot.copilot_cloud_agent %} enabled to initiate, monitor, and manage agent sessions without leaving your workflow. You can also use the [Agents page](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text) to view and start agent sessions. To learn how to enable {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/enterprise/cloud-agent-access). diff --git a/data/reusables/copilot/cloud-agent/automations-availability.md b/data/reusables/copilot/cloud-agent/automations-availability.md index b9cd578e52c4..da38429bc2b7 100644 --- a/data/reusables/copilot/cloud-agent/automations-availability.md +++ b/data/reusables/copilot/cloud-agent/automations-availability.md @@ -1,7 +1,7 @@ For {% data variables.copilot.copilot_automations %} to be available in a repository, all of the following must be true: * The repository must be **private or internal**. {% data variables.copilot.copilot_automations_cap %} are not available in public repositories. -* {% data variables.copilot.copilot_cloud_agent %} must be enabled for the repository. If you have {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %}, an administrator must enable the {% data variables.copilot.copilot_cloud_agent %} policy. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management). +* {% data variables.copilot.copilot_cloud_agent %} must be enabled for the repository. If you have {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %}, an administrator must enable the {% data variables.copilot.copilot_cloud_agent %} policy. See [AUTOTITLE](/copilot/concepts/enterprise/cloud-agent-access). * The organization must allow both {% data variables.copilot.copilot_cloud_agent %} and {% data variables.copilot.copilot_automations %} in the repository (both are enabled by default). See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent). {% data variables.copilot.copilot_automations_cap %} are available with the {% data variables.copilot.copilot_pro %}, {% data variables.copilot.copilot_pro_plus %}, {% data variables.copilot.copilot_max %}, {% data variables.copilot.copilot_for_business %}, and {% data variables.copilot.copilot_enterprise %} plans. diff --git a/data/reusables/copilot/copilot-requires-subscription.md b/data/reusables/copilot/copilot-requires-subscription.md index b425dbfcc047..5cca5844e11a 100644 --- a/data/reusables/copilot/copilot-requires-subscription.md +++ b/data/reusables/copilot/copilot-requires-subscription.md @@ -1 +1 @@ -You'll need access to {% data variables.product.prodname_copilot %}. For more information, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +You'll need access to {% data variables.product.prodname_copilot %}. For more information, see [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). diff --git a/data/reusables/copilot/model-autoenablement.md b/data/reusables/copilot/model-autoenablement.md index ae612bff83db..0e2af8666b26 100644 --- a/data/reusables/copilot/model-autoenablement.md +++ b/data/reusables/copilot/model-autoenablement.md @@ -1 +1 @@ -For enterprises on a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, a policy controls whether unconfigured generally available (GA) models are enabled or disabled by default. See [AUTOTITLE](/copilot/concepts/models/default-availability). +For enterprises on a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, a policy controls whether unconfigured generally available (GA) models are enabled or disabled by default. See [AUTOTITLE](/copilot/concepts/enterprise/default-model-availability). diff --git a/data/reusables/copilot/model-compliance/pricing-changes.md b/data/reusables/copilot/model-compliance/pricing-changes.md index 836397ba7544..f98af2cb9940 100644 --- a/data/reusables/copilot/model-compliance/pricing-changes.md +++ b/data/reusables/copilot/model-compliance/pricing-changes.md @@ -2,4 +2,4 @@ For example, if an interaction would normally consume 100 {% data variables.product.prodname_ai_credits_short %}, the same interaction processed with this enforcement enabled consumes 110 {% data variables.product.prodname_ai_credits_short %}. This pricing applies to all compliant model requests across all providers. -See [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-organizations-and-enterprises). +See [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/billing). diff --git a/data/reusables/copilot/model-compliance/supported-features.md b/data/reusables/copilot/model-compliance/supported-features.md index 58622a6f80ac..753bcccf1b01 100644 --- a/data/reusables/copilot/model-compliance/supported-features.md +++ b/data/reusables/copilot/model-compliance/supported-features.md @@ -1,3 +1,3 @@ -All generally available {% data variables.product.prodname_copilot_short %} features work with this enforcement. See [AUTOTITLE](/copilot/get-started/features). +All generally available {% data variables.product.prodname_copilot_short %} features work with this enforcement. The availability of features is visible under {% data variables.product.prodname_copilot_short %} policy controls, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). Preview features that reach general availability will be supported with compliant model alternatives at the time of their GA release. diff --git a/data/reusables/copilot/quickstart-intro.md b/data/reusables/copilot/quickstart-intro.md index 7a3ae769c315..d22b7c59422a 100644 --- a/data/reusables/copilot/quickstart-intro.md +++ b/data/reusables/copilot/quickstart-intro.md @@ -1 +1 @@ -{% data variables.product.prodname_copilot %} provides coding suggestions as you type in your editor. You can also ask {% data variables.product.prodname_copilot_short %} coding-related questions, such as how best to code something, how to fix a bug, or how someone else's code works. For full details of what {% data variables.product.prodname_copilot_short %} can do, see [AUTOTITLE](/copilot/get-started/what-is-github-copilot). +{% data variables.product.prodname_copilot %} provides coding suggestions as you type in your editor. You can also ask {% data variables.product.prodname_copilot_short %} coding-related questions, such as how best to code something, how to fix a bug, or how someone else's code works. For full details of what {% data variables.product.prodname_copilot_short %} can do, see [AUTOTITLE](/copilot/get-started/about-github-copilot). diff --git a/data/reusables/copilot/subscription-prerequisite.md b/data/reusables/copilot/subscription-prerequisite.md index 13cd0bdd3318..dfd0742cd63d 100644 --- a/data/reusables/copilot/subscription-prerequisite.md +++ b/data/reusables/copilot/subscription-prerequisite.md @@ -1 +1 @@ -See [AUTOTITLE](/copilot/get-started/what-is-github-copilot#get-access). +See [AUTOTITLE](/copilot/get-started/about-github-copilot#get-access). diff --git a/data/reusables/organizations/copilot-policy-ent-overrides-org.md b/data/reusables/organizations/copilot-policy-ent-overrides-org.md index a9ad35c611ed..87642857b0ea 100644 --- a/data/reusables/organizations/copilot-policy-ent-overrides-org.md +++ b/data/reusables/organizations/copilot-policy-ent-overrides-org.md @@ -1 +1 @@ -{% data variables.product.prodname_copilot_short %} policies are also managed at the enterprise level. If your enterprise owner has selected a specific policy, such as enabling a feature everywhere, disabling it everywhere, or enabling it for selected organizations only, you cannot override that setting at the organization level. For information on how policies combine, see [AUTOTITLE](/copilot/concepts/policies). +{% data variables.product.prodname_copilot_short %} policies are also managed at the enterprise level. If your enterprise owner has selected a specific policy, such as enabling a feature everywhere, disabling it everywhere, or enabling it for selected organizations only, you cannot override that setting at the organization level. For information on how policies combine, see [AUTOTITLE](/copilot/concepts/enterprise/policies). diff --git a/data/reusables/rai/copilot/enterprise-fpt-link.md b/data/reusables/rai/copilot/enterprise-fpt-link.md index ba9aa7f4419a..7fe1c1aba588 100644 --- a/data/reusables/rai/copilot/enterprise-fpt-link.md +++ b/data/reusables/rai/copilot/enterprise-fpt-link.md @@ -1 +1 @@ -> [!NOTE] You are currently viewing the documentation for Free, Pro, and Team plans. {% data variables.copilot.copilot_enterprise %} is only available to customers on the {% data variables.product.prodname_ghe_cloud %} plan. For full documentation of {% data variables.copilot.copilot_enterprise_short %}, see [AUTOTITLE](/enterprise-cloud@latest/copilot/get-started/what-is-github-copilot) in the {% data variables.product.prodname_ghe_cloud %} documentation. +> [!NOTE] You are currently viewing the documentation for Free, Pro, and Team plans. {% data variables.copilot.copilot_enterprise %} is only available to customers on the {% data variables.product.prodname_ghe_cloud %} plan. For full documentation of {% data variables.copilot.copilot_enterprise_short %}, see [AUTOTITLE](/enterprise-cloud@latest/copilot/get-started/about-github-copilot) in the {% data variables.product.prodname_ghe_cloud %} documentation. diff --git a/src/content-pipelines/state/copilot-cli.sha b/src/content-pipelines/state/copilot-cli.sha index 43f24c9f055d..93d3d808abd3 100644 --- a/src/content-pipelines/state/copilot-cli.sha +++ b/src/content-pipelines/state/copilot-cli.sha @@ -1 +1 @@ -2a544262cc3ef9298fa36c38bcfc454d625d0888 +5ce1aa09128c57a8a240d93f5089e35969c8c4d9