Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ docsTeamMetrics:
- copilot-cli
---

This article explains the concepts around remote access to {% data variables.copilot.copilot_cli_short %} sessions. For instructions on how to enable remote access, see [AUTOTITLE](/copilot/how-tos/copilot-cli/steer-remotely).
This article explains the concepts around remote access to {% data variables.copilot.copilot_cli_short %} sessions. For instructions on how to enable remote access, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/steer-remotely).

## Introduction

Expand Down Expand Up @@ -64,9 +64,9 @@ When connected to a session remotely from {% data variables.product.prodname_dot

If the connection between your local machine and {% data variables.product.prodname_dotcom %} is temporarily lost—for example, due to a network interruption—you can continue using the session remotely as soon as the connection is restored.

You can use the `/keep-alive` slash command to prevent your machine from going to sleep. See [Preventing your machine from going to sleep](/copilot/how-tos/copilot-cli/steer-remotely#preventing-your-machine-from-going-to-sleep).
You can use the `/keep-alive` slash command to prevent your machine from going to sleep. See [Preventing your machine from going to sleep](/copilot/how-tos/copilot-cli/use-copilot-cli/steer-remotely#preventing-your-machine-from-going-to-sleep).

If you closed a session that had remote access enabled, when you resume the session—either using `copilot --continue` or `copilot --resume=ID`—you must re-enable remote access. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/steer-remotely#resuming-a-session-with-remote-access).
If you closed a session that had remote access enabled, when you resume the session—either using `copilot --continue` or `copilot --resume=ID`—you must re-enable remote access. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/steer-remotely#resuming-a-session-with-remote-access).

## Visibility of remote access sessions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ As a rule of thumb, use <kbd>Esc</kbd> when you want to intervene selectively, a

While {% data variables.product.prodname_copilot_short %} is inactive and there is no text in the input area, you can press <kbd>Esc</kbd> twice to display a list of points in your current session that you can roll back to. Each point corresponds to a snapshot of your workspace that was taken immediately before {% data variables.product.prodname_copilot_short %} started working on the prompt shown in the list.

For full details of how to use the double <kbd>Esc</kbd> keypress to roll back changes made during a session, see [AUTOTITLE](/copilot/how-tos/copilot-cli/roll-back-changes).
For full details of how to use the double <kbd>Esc</kbd> keypress to roll back changes made during a session, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/roll-back-changes).

> [!WARNING]
> {% data reusables.copilot.copilot-cli.cli-rewind-warning %}
Expand Down
4 changes: 2 additions & 2 deletions content/copilot/concepts/agents/copilot-cli/chronicle.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This session data powers several features:
* **Asking questions about your history**: You can ask {% data variables.product.prodname_copilot_short %} questions about your past work, and it will query your session data to answer them.
* **The `/chronicle` slash command**: A set of purpose-built subcommands that generate standup reports, personalized tips, and suggestions for improving your custom instructions—all derived from your session history.

This conceptual article explains how session data is stored, and how you can leverage it to enhance your workflow. For a practical guide to resuming a session, asking {% data variables.product.prodname_copilot_short %} about your CLI sessions, and using the `/chronicle` slash command, see [AUTOTITLE](/copilot/how-tos/copilot-cli/chronicle).
This conceptual article explains how session data is stored, and how you can leverage it to enhance your workflow. For a practical guide to resuming a session, asking {% data variables.product.prodname_copilot_short %} about your CLI sessions, and using the `/chronicle` slash command, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle).

{% data reusables.copilot.copilot-cli.cli-experimental-chronicle %}

Expand Down Expand Up @@ -92,5 +92,5 @@ To reindex the session store, use the following slash command in an interactive

## Further reading

* [AUTOTITLE](/copilot/how-tos/copilot-cli/chronicle)
* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle)
* [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-command-reference)
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,10 @@ Avoid hooks when:

### Find out more about hooks

See [AUTOTITLE](/copilot/how-tos/copilot-cli/use-hooks).
See:
* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-hooks)
* [AUTOTITLE](/copilot/reference/hooks-configuration)
* [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-hooks-reference)

## Subagents

Expand Down
4 changes: 2 additions & 2 deletions content/copilot/concepts/agents/copilot-cli/fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ 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/speed-up-task-completion).
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).

## How `/fleet` works

Expand Down Expand Up @@ -70,6 +70,6 @@ For more information about autopilot mode, see [AUTOTITLE](/copilot/concepts/age

## Further reading

* [AUTOTITLE](/copilot/how-tos/copilot-cli/speed-up-task-completion)
* [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion)
* [AUTOTITLE](/copilot/how-tos/copilot-cli)
* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli)
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ docsTeamMetrics:

## Introduction

Plugins are packages that extend the functionality of {% data variables.copilot.copilot_cli_short %}. You can install a plugin from a marketplace that you have registered with the CLI, from a Git repository, or from a local path.
Plugins are packages that extend the functionality of {% data variables.copilot.copilot_cli_short %}. You can install a plugin from a marketplace that you have registered with the CLI.

For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-cli-plugins).

Expand All @@ -26,8 +26,6 @@ For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about

Plugins are collected together in marketplaces. A marketplace is a registry of plugins that you can browse and install from. You can add a marketplace to your CLI configuration, which allows you to use the CLI to browse and install plugins from that marketplace—see [Adding plugin marketplaces](#adding-plugin-marketplaces). {% data variables.product.prodname_copilot_short %} comes with two marketplaces already registered by default: `copilot-plugins` and `awesome-copilot`.

Alternatively, you can search for plugin marketplaces online and then add a plugin directly from a repository.

To use the CLI to browse the plugins in one of your registered marketplaces:

1. **Check which marketplaces are currently registered.**
Expand Down Expand Up @@ -55,11 +53,9 @@ To use the CLI to browse the plugins in one of your registered marketplaces:

## Installing plugins

Typically, you'll install a plugin from one of your registered marketplaces. However, you can also install a plugin directly from a Git repository, or from a local path.

For information on how to register additional marketplaces, see [Adding and removing plugin marketplaces](#adding-and-removing-plugin-marketplaces).
You can install plugins from a registered marketplace. For information on how to register additional marketplaces, see [Adding plugin marketplaces](#adding-plugin-marketplaces).

### Install from a registered marketplace
To install a plugin, enter:

```shell copy
copilot plugin install PLUGIN-NAME@MARKETPLACE-NAME
Expand All @@ -77,43 +73,6 @@ Alternatively, in an interactive session, enter:
/plugin install PLUGIN-NAME@MARKETPLACE-NAME
```

### Install directly from an online Git repository

You can install a plugin directly from a repository, rather than doing so using a registered marketplace.

To install a plugin directly from a repository **on {% data variables.product.prodname_dotcom_the_website %}**, enter:

```shell copy
copilot plugin install OWNER/REPO
```

To install a plugin from **any online Git repository**, enter:

```shell copy
copilot plugin install URL-OF-GIT-REPO
```

For example, `copilot plugin install https://gitlab.com/OWNER/REPO.git`.

> [!IMPORTANT]
> For these commands to work, the repository must contain a `plugin.json` file in a `.plugin`, `.github/plugin`, or `.claude-plugin` directory, or at the root of the repository.

To install a plugin directly from a repository on {% data variables.product.prodname_dotcom_the_website %} where the `plugin.json` file is located somewhere other than `.github/plugin`, `.claude-plugin`, or the repository root—for example, if you are installing a plugin directly from a marketplace repository such as [anthropics/claude-code](https://github.com/anthropics/claude-code)—enter:

```shell copy
copilot plugin install OWNER/REPO:PATH/TO/PLUGIN
```

Where `PATH/TO/PLUGIN` is the path from the root of the repository to a directory that contains `plugin.json`, `.github/plugin/plugin.json` or `.claude-plugin/plugin.json`.

For example, `copilot plugin install anthropics/claude-code:plugins/frontend-design`

### Install from a local path

```shell copy
copilot plugin install ./PATH/TO/PLUGIN
```

## Managing installed plugins

```bash
Expand All @@ -122,10 +81,6 @@ copilot plugin update PLUGIN-NAME # Update plugin to latest version
copilot plugin uninstall PLUGIN-NAME # Remove plugin completely
```

## Where plugins are stored

Plugins installed from a marketplace are stored at: `~/.copilot/installed-plugins/MARKETPLACE/PLUGIN-NAME/`. Plugins installed directly (for example, from a local path) are stored at: `~/.copilot/installed-plugins/_direct/SOURCE-ID/`.

## Adding plugin marketplaces

To add a marketplace to the list of registered marketplaces, enter the following command in the terminal:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ docsTeamMetrics:
* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent)
* [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli)
* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment)
* [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-hooks-reference)
71 changes: 40 additions & 31 deletions content/copilot/how-tos/copilot-cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,53 +17,62 @@ children:
- /cli-getting-started
- /cli-best-practices
- /set-up-copilot-cli
- /allowing-tools
- /steer-remotely
- /use-copilot-cli
- /automate-copilot-cli
- /customize-copilot
- /connecting-vs-code
- /use-copilot-cli-agents
- /administer-copilot-cli-for-your-enterprise
- /speed-up-task-completion
- /manage-pull-requests
- /roll-back-changes
- /chronicle
- /content/copilot/concepts/agents/copilot-cli/about-copilot-cli
- /content/copilot/concepts/agents/copilot-cli/comparing-cli-features
- /content/copilot/concepts/agents/copilot-cli/cancel-and-roll-back
- /automate-copilot-cli/automate-with-actions
- /automate-copilot-cli/quickstart
- /automate-copilot-cli/run-cli-programmatically
- /content/copilot/concepts/agents/about-agent-skills
- /content/copilot/concepts/agents/copilot-cli/about-cli-plugins
- /content/copilot/concepts/agents/copilot-cli/autopilot
- /content/copilot/concepts/agents/copilot-cli/about-copilot-cli
- /content/copilot/concepts/agents/copilot-cli/about-remote-access
- /content/copilot/concepts/agents/copilot-cli/fleet
- /content/copilot/concepts/agents/copilot-cli/research
- /content/copilot/concepts/agents/copilot-cli/lsp-servers
- /content/copilot/concepts/agents/copilot-cli/autopilot
- /content/copilot/concepts/agents/copilot-cli/cancel-and-roll-back
- /content/copilot/concepts/agents/copilot-cli/chronicle
- /content/copilot/concepts/agents/copilot-cli/comparing-cli-features
- /content/copilot/concepts/agents/copilot-cli/context-management
- /set-up-copilot-cli/install-copilot-cli
- /set-up-copilot-cli/configure-copilot-cli
- /set-up-copilot-cli/add-lsp-servers
- /automate-copilot-cli/quickstart
- /automate-copilot-cli/automate-with-actions
- /automate-copilot-cli/run-cli-programmatically
- /content/copilot/concepts/agents/copilot-cli/fleet
- /content/copilot/concepts/agents/copilot-cli/lsp-servers
- /content/copilot/concepts/agents/copilot-cli/research
- /content/copilot/reference/copilot-cli-reference/acp-server
- /content/copilot/reference/copilot-cli-reference/cli-command-reference
- /content/copilot/reference/copilot-cli-reference/cli-plugin-reference
- /content/copilot/reference/copilot-cli-reference/cli-programmatic-reference
- /content/copilot/reference/hooks-configuration
- /content/copilot/responsible-use/copilot-cli
- /content/copilot/tutorials/copilot-cli-hooks
- /customize-copilot/add-custom-instructions
- /customize-copilot/create-custom-agents-for-cli
- /customize-copilot/add-mcp-servers
- /customize-copilot/add-skills
- /customize-copilot/create-custom-agents-for-cli
- /customize-copilot/overview
- /customize-copilot/plugins-creating
- /customize-copilot/plugins-finding-installing
- /customize-copilot/plugins-marketplace
- /customize-copilot/overview
- /customize-copilot/use-byok-models
- /customize-copilot/use-hooks
- /content/copilot/reference/copilot-cli-reference/cli-command-reference
- /content/copilot/reference/copilot-cli-reference/cli-plugin-reference
- /content/copilot/reference/copilot-cli-reference/cli-programmatic-reference
- /content/copilot/reference/copilot-cli-reference/acp-server
- /content/copilot/reference/hooks-configuration
- /content/copilot/tutorials/copilot-cli-hooks
- /content/copilot/responsible-use/copilot-cli
- /set-up-copilot-cli/add-lsp-servers
- /set-up-copilot-cli/authenticate-copilot-cli
- /set-up-copilot-cli/configure-copilot-cli
- /set-up-copilot-cli/install-copilot-cli
- /set-up-copilot-cli/troubleshoot-copilot-cli-auth
- /use-copilot-cli/agentic-code-review
- /use-copilot-cli/allowing-tools
- /use-copilot-cli/chronicle
- /use-copilot-cli/connecting-vs-code
- /use-copilot-cli/delegate-tasks-to-cca
- /use-copilot-cli/invoke-custom-agents
- /use-copilot-cli/manage-pull-requests
- /use-copilot-cli/overview
- /use-copilot-cli/roll-back-changes
- /use-copilot-cli/speed-up-task-completion
- /use-copilot-cli/steer-agents
- /use-copilot-cli/steer-remotely
carousels:
recommended:
- /copilot/how-tos/copilot-cli/use-copilot-cli-agents/overview
- /copilot/how-tos/copilot-cli/use-copilot-cli/overview
- /copilot/how-tos/copilot-cli/cli-best-practices
- /copilot/reference/copilot-cli-reference/cli-command-reference
includedCategories:
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ product: '{% data reusables.gated-features.copilot-cli %}'
versions:
feature: copilot
contentType: how-tos
redirect_from:
- /copilot/how-tos/copilot-cli/use-copilot-cli-agents/agentic-code-review
category:
- Build with Copilot CLI
docsTeamMetrics:
- copilot-cli
---

## About agentic code review
## About agentic code review

You can use the `/review` slash command to have {% data variables.product.prodname_copilot_short %} analyze code changes without leaving the CLI. This lets you get quick feedback on your changes prior to committing.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: 'Control which tools {% data variables.copilot.copilot_cli_short %} can u
versions:
feature: copilot
contentType: how-tos
redirect_from:
- /copilot/how-tos/copilot-cli/allowing-tools
category:
- Author and optimize with Copilot # Copilot discovery page
- Build with Copilot CLI # Copilot CLI bespoke page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ intro: 'Resume previous {% data variables.copilot.copilot_cli_short %} sessions,
versions:
feature: copilot
contentType: how-tos
redirect_from:
- /copilot/how-tos/copilot-cli/chronicle
category:
- Author and optimize with Copilot # Copilot discovery page
- Build with Copilot CLI # Copilot CLI bespoke page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ intro: 'Connect {% data variables.copilot.copilot_cli_short %} to {% data variab
versions:
feature: copilot
contentType: how-tos
redirect_from:
- /copilot/how-tos/copilot-cli/connecting-vs-code
category:
- Author and optimize with Copilot # Copilot discovery page
- Build with Copilot CLI # Copilot CLI bespoke page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ product: '{% data reusables.gated-features.copilot-cli %}'
versions:
feature: copilot
contentType: how-tos
redirect_from:
- /copilot/how-tos/copilot-cli/use-copilot-cli-agents/delegate-tasks-to-cca
category:
- Build with Copilot CLI
docsTeamMetrics:
Expand Down Expand Up @@ -48,4 +50,4 @@ Alternatively, prefix a prompt with `&` to delegate it:

## Next steps

To learn how to invoke specialized agents tailored to specific tasks, such as code review, documentation, or security audits, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli-agents/invoke-custom-agents).
To learn how to invoke specialized agents tailored to specific tasks, such as code review, documentation, or security audits, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/invoke-custom-agents).
25 changes: 25 additions & 0 deletions content/copilot/how-tos/copilot-cli/use-copilot-cli/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: 'Use {% data variables.copilot.copilot_cli %}'
shortTitle: 'Use {% data variables.copilot.copilot_cli_short %}'
intro: Understand the different ways you can use {% data variables.product.prodname_copilot %} in your terminal.
versions:
feature: copilot
redirect_from:
- /copilot/how-tos/copilot-cli/use-copilot-cli-agents
children:
- /overview
- /allowing-tools
- /connecting-vs-code
- /delegate-tasks-to-cca
- /roll-back-changes
- /invoke-custom-agents
- /steer-agents
- /steer-remotely
- /agentic-code-review
- /manage-pull-requests
- /speed-up-task-completion
- /chronicle
contentType: how-tos
docsTeamMetrics:
- copilot-cli
---
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ product: '{% data reusables.gated-features.copilot-cli %}'
versions:
feature: copilot
contentType: how-tos
redirect_from:
- /copilot/how-tos/copilot-cli/use-copilot-cli-agents/invoke-custom-agents
category:
- Build with Copilot CLI
docsTeamMetrics:
Expand Down Expand Up @@ -110,4 +112,4 @@ For more detailed information on adding and managing MCP servers in {% data vari

## Next steps

To learn how to guide and refine agent behavior during task execution to keep work on track, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli-agents/steer-agents).
To learn how to guide and refine agent behavior during task execution to keep work on track, see [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/steer-agents).
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: 'Use the `/pr` slash command to view, create, and fix pull requests direc
versions:
feature: copilot
contentType: how-tos
redirect_from:
- /copilot/how-tos/copilot-cli/manage-pull-requests
category:
- Author and optimize with Copilot # Copilot discovery page
- Build with Copilot CLI # Copilot CLI bespoke page
Expand Down
Loading
Loading