@sujal-kb007/copilot-setup

One npm install to share GitHub Copilot instructions across your entire team — no manual file copying, no repo clutter.

What it does

On install, this package automatically:

1. Copies shared instruction files into your project's .github/ directory
2. Merges Copilot configuration into .vscode/settings.json

Files installed

your-project/
├── .github/
│   ├── copilot-instructions.md    ← shared coding instructions
│   └── test-instructions.md       ← test generation instructions
└── .vscode/
    └── settings.json              ← Copilot settings (merged, not overwritten)

Installation

As a dev dependency (recommended)

npm install @sujal-kb007/copilot-setup --save-dev

The postinstall hook runs automatically and sets everything up.

One-time setup via npx

npx @sujal-kb007/copilot-setup

Force overwrite existing files

npx @sujal-kb007/copilot-setup --force

Customizing instructions

After install, edit the files in .github/ to match your team's conventions. The package will not overwrite files that already exist (unless you use --force).

To update the shared defaults for your org, update the templates in this package and publish a new version.

Publishing to your org

# 1. Update templates in templates/.github/
# 2. Bump version
npm version patch

# 3. Publish (to npm or your private registry)
npm publish --access public

Using GitHub Packages instead of npm

Add to package.json:

{
  "publishConfig": {
    "@sujal-kb007:registry": "https://npm.pkg.github.com"
  }
}

Then:

npm login --scope=@sujal-kb007 --registry=https://npm.pkg.github.com
npm publish

How it works

• postinstall hook — runs setup.js after npm install, which copies templates into the consuming project
• Existing files are preserved — won't overwrite your customized files unless --force is used
• .vscode/settings.json is merged — only adds Copilot keys if they don't already exist
• Works with scoped packages — correctly resolves the project root from node_modules/@sujal-kb007/copilot-setup/

License

MIT