Skip to content

Bug: README install instructions use incorrect copilot plugin install syntax #10

Description

@sendtoshailesh

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 workscopilot 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 errorscopilot 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.jsonplugins[0].name
  • git-ape (after @) = the marketplace name registered in step 1

Troubleshooting Performed

  1. Confirmed marketplace was registered in ~/.copilot/config.json
  2. Confirmed cache existed at ~/Library/Caches/copilot/marketplaces/Azure-git-ape/ with all agents and skills ✅
  3. Confirmed plugin was NOT in installedPlugins array in config.json
  4. Confirmed no git-ape directory existed in ~/.copilot/installed-plugins/
  5. Ran copilot plugin install git-ape@git-apePlugin "git-ape" installed successfully.
  6. Verified with copilot plugin list — git-ape now appears ✅
  7. 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

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

Fields

No fields configured for Bug.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions