Skip to content

Commit e61d38a

Browse files
hubwriterCopilot
andauthored
Copilot CLI: tiny additions to plugin docs (#59692)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent d7d8ba3 commit e61d38a

3 files changed

Lines changed: 33 additions & 13 deletions

File tree

content/copilot/how-tos/copilot-cli/customize-copilot/plugins-finding-installing.md

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ contentType: how-tos
1515

1616
## Introduction
1717

18-
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 {% data variables.product.github %} repository, or from a local path.
18+
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.
1919

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

@@ -49,12 +49,12 @@ To use the CLI to browse the plugins in one of your registered marketplaces:
4949

5050
```shell copy
5151
copilot plugin marketplace browse MARKETPLACE-NAME
52-
52+
5353
```
5454

5555
## Installing plugins
5656

57-
Typically, you'll install a plugin from one of your registered marketplaces. However, you can also install a plugin directly from a {% data variables.product.github %} repository, or from a local path.
57+
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.
5858

5959
For information on how to register additional marketplaces, see [Adding and removing plugin marketplaces](#adding-and-removing-plugin-marketplaces).
6060

@@ -76,20 +76,37 @@ Alternatively, in an interactive session, enter:
7676
/plugin install PLUGIN-NAME@MARKETPLACE-NAME
7777
```
7878

79-
### Install from {% data variables.product.github %} directly
79+
### Install directly from an online Git repository
80+
81+
You can install a plugin directly from a repository, rather than doing so using a registered marketplace.
8082

81-
You can install a plugin directly from a {% data variables.product.github %} repository, without first adding a marketplace to your list of registered marketplaces.
83+
To install a plugin directly from a repository **on {% data variables.product.prodname_dotcom_the_website %}**, enter:
8284

8385
```shell copy
84-
copilot plugin install OWNER/REPO:PATH/TO/PLUGIN
86+
copilot plugin install OWNER/REPO
87+
```
88+
89+
To install a plugin from **any online Git repository**, enter:
90+
91+
```shell copy
92+
copilot plugin install URL-OF-GIT-REPO
8593
```
8694

87-
For example,
95+
For example, `copilot plugin install https://gitlab.com/OWNER/REPO.git`.
96+
97+
> [!IMPORTANT]
98+
> For these commands to work, the repository must contain a `plugin.json` file in a `.github/plugin` or `.claude-plugin` directory, or at the root of the repository.
99+
100+
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:
88101

89102
```shell copy
90-
copilot plugin install github/awesome-copilot:plugins/security-best-practices
103+
copilot plugin install OWNER/REPO:PATH/TO/PLUGIN
91104
```
92105

106+
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`.
107+
108+
For example, `copilot plugin install anthropics/claude-code:plugins/frontend-design`
109+
93110
### Install from a local path
94111

95112
```shell copy
@@ -130,16 +147,16 @@ Alternatively, in an interactive session, enter:
130147
/plugin marketplace add OWNER/REPO
131148
```
132149

133-
If a marketplace is located on the local file system, instead of on {% data variables.product.github %}, use the path to the marketplace directory instead of OWNER/REPO. For example:
150+
If a marketplace is located on the local file system, instead of on {% data variables.product.prodname_dotcom_the_website %}, use the path to the marketplace directory instead of OWNER/REPO. For example:
134151

135152
```shell copy
136153
copilot plugin marketplace add /PATH/TO/MARKETPLACE-DIRECTORY
137154
```
138155

139-
If a marketplace is located in a Git repository that is not hosted on {% data variables.product.github %}, use the URL of the Git repository. For example:
156+
If a marketplace is located in a Git repository that is not hosted on {% data variables.product.prodname_dotcom_the_website %}, use the URL of the Git repository. For example:
140157

141158
```shell copy
142-
copilot plugin marketplace add https://gitlab.example.com/team/plugins.git
159+
copilot plugin marketplace add https://gitlab.com/OWNER/REPO.git
143160
```
144161

145162
## Removing plugin marketplaces
@@ -157,7 +174,8 @@ Or, in an interactive session:
157174
```
158175

159176
> [!NOTE]
160-
> When adding a marketplace you reference the marketplace using the OWNER/REPO of the {% data variables.product.github %} repository that has been configured as a marketplace. When removing a marketplace, however, you reference the name of the marketplace as it appears in your list of registered marketplaces.
177+
> * When adding a marketplace you reference the marketplace using the OWNER/REPO of the {% data variables.product.github %} repository that has been configured as a marketplace. When removing a marketplace, however, you reference the name of the marketplace as it appears in your list of registered marketplaces.
178+
> * If you attempt to remove a marketplace that has plugins installed, the command will fail with an error message that lists the plugins that are currently installed from that marketplace. Add the `--force` option to the command to remove the marketplace and uninstall all plugins that were installed from that marketplace.
161179
162180
## Further reading
163181

content/copilot/how-tos/copilot-cli/customize-copilot/quickstart-for-customizing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,5 @@ For more information, see [AUTOTITLE](/copilot/concepts/context/mcp).
6161
{% data variables.copilot.copilot_cli_short %} plugins are distributable packages that provide a simple way to extend the functionality of the CLI.
6262

6363
They bundle multiple customization components together into a single installable unit. You can install plugins directly from a repository, from a plugin marketplace, or from a local path.
64+
65+
For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-cli-plugins).

content/copilot/reference/cli-plugin-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-cop
131131
| `hooks` | string \| object | No | Path to hooks config or inline hooks object. |
132132
| `mcpServers` | string \| object | No | Path to MCP config or inline server definitions. |
133133
| `lspServers` | string \| object | No | Path to LSP config or inline server definitions. |
134-
| `strict` | boolean | No | If false, plugin doesn't need its own `plugin.json`. Default: true. |
134+
| `strict` | boolean | No | When `true` (the default), plugins must conform to the full schema and validation rules. When `false`, relaxed validation is used, allowing more flexibility—especially for direct installs or legacy plugins. |
135135

136136
## File locations
137137

0 commit comments

Comments
 (0)