Bug: README install instructions fail — incorrect copilot plugin install syntax
Summary
The README.md install instructions document incorrect CLI commands for installing the git-ape plugin. Following the documented steps exactly results in a failed installation where the marketplace is registered but the plugin is never actually installed.
Steps to Reproduce (what the README says)
The README currently documents:
copilot plugin marketplace add Azure/git-ape
copilot plugin install Azure/git-ape
What Actually Happens
Step 1 works — copilot plugin marketplace add Azure/git-ape successfully registers the marketplace in ~/.copilot/config.json:
"marketplaces": {
"git-ape": {
"source": { "source": "github", "repo": "Azure/git-ape" }
}
}
The marketplace cache is populated at ~/Library/Caches/copilot/marketplaces/Azure-git-ape/.
Step 2 fails silently or errors — copilot plugin install Azure/git-ape does NOT use the marketplace syntax. The copilot plugin install command expects one of these source formats (from copilot plugin install --help):
| Format |
Meaning |
plugin@marketplace |
Install from a registered marketplace |
owner/repo |
Install directly from a GitHub repository |
owner/repo:path |
Install from a repo subdirectory |
https://... |
Install from a git URL |
Using Azure/git-ape matches the owner/repo format (direct repo install), NOT the plugin@marketplace format. This may appear to succeed but does not properly register the plugin in the installedPlugins list in config.json, resulting in agents and skills not loading.
What Actually Fixes It
The correct command to install from the registered marketplace is:
copilot plugin install git-ape@git-ape
Format: <plugin-name>@<marketplace-name>, where:
git-ape (before @) = the plugin name from marketplace.json → plugins[0].name
git-ape (after @) = the marketplace name registered in step 1
Troubleshooting Performed
- Confirmed marketplace was registered in
~/.copilot/config.json ✅
- Confirmed cache existed at
~/Library/Caches/copilot/marketplaces/Azure-git-ape/ with all agents and skills ✅
- Confirmed plugin was NOT in
installedPlugins array in config.json ❌
- Confirmed no
git-ape directory existed in ~/.copilot/installed-plugins/ ❌
- Ran
copilot plugin install git-ape@git-ape → Plugin "git-ape" installed successfully. ✅
- Verified with
copilot plugin list — git-ape now appears ✅
- Verified files installed at
~/.copilot/installed-plugins/git-ape/git-ape/ with all 8 agents and 13 skills ✅
Proposed Fix
Update the README.md "Get Started" → "1. Install the plugin" section from:
copilot plugin marketplace add Azure/git-ape
copilot plugin install Azure/git-ape
To:
copilot plugin marketplace add Azure/git-ape
copilot plugin install git-ape@git-ape
And optionally add a verification step:
copilot plugin list # Should show: git-ape@git-ape (v0.0.1)
Environment
- Copilot CLI version: 1.0.28
- OS: macOS (Darwin)
- Shell: Bash
- git-ape version: 0.0.1
Bug: README install instructions fail — incorrect
copilot plugin installsyntaxSummary
The README.md install instructions document incorrect CLI commands for installing the git-ape plugin. Following the documented steps exactly results in a failed installation where the marketplace is registered but the plugin is never actually installed.
Steps to Reproduce (what the README says)
The README currently documents:
What Actually Happens
Step 1 works —
copilot plugin marketplace add Azure/git-apesuccessfully registers the marketplace in~/.copilot/config.json:The marketplace cache is populated at
~/Library/Caches/copilot/marketplaces/Azure-git-ape/.Step 2 fails silently or errors —
copilot plugin install Azure/git-apedoes NOT use the marketplace syntax. Thecopilot plugin installcommand expects one of these source formats (fromcopilot plugin install --help):plugin@marketplaceowner/repoowner/repo:pathhttps://...Using
Azure/git-apematches theowner/repoformat (direct repo install), NOT theplugin@marketplaceformat. This may appear to succeed but does not properly register the plugin in theinstalledPluginslist inconfig.json, resulting in agents and skills not loading.What Actually Fixes It
The correct command to install from the registered marketplace is:
Format:
<plugin-name>@<marketplace-name>, where:git-ape(before @) = the plugin name frommarketplace.json→plugins[0].namegit-ape(after @) = the marketplace name registered in step 1Troubleshooting Performed
~/.copilot/config.json✅~/Library/Caches/copilot/marketplaces/Azure-git-ape/with all agents and skills ✅installedPluginsarray inconfig.json❌git-apedirectory existed in~/.copilot/installed-plugins/❌copilot plugin install git-ape@git-ape→Plugin "git-ape" installed successfully.✅copilot plugin list— git-ape now appears ✅~/.copilot/installed-plugins/git-ape/git-ape/with all 8 agents and 13 skills ✅Proposed Fix
Update the README.md "Get Started" → "1. Install the plugin" section from:
To:
And optionally add a verification step:
copilot plugin list # Should show: git-ape@git-ape (v0.0.1)Environment