Installation

Prerequisites

• ✓Node.js ≥ 22 — required for the CLI runtime
• ✓GitHub Copilot extension in VS Code (free or paid plan)
• ✓Internet connection — the CLI downloads content from GitHub at runtime

Option A: Use with npx (recommended)

No installation required. Run directly from npm:

npx @ntdev204/copilot-kit init

This downloads and runs the latest version every time. Ideal for one-time use or when you want to always use the newest release.

Option B: Install globally

Install once, use anywhere:

npm install -g @ntdev204/copilot-kit
copilot-kit init

What happens during init?

Running init downloads and extracts the following into your project's root:

Existing .github/ directory

If a .github/ directory already exists, init automatically merges — new files are added and existing files are left untouched:

  ℹ  .github/ already exists — new files will be added, existing files kept.

  ✔  Merged successfully!
     Existing files were preserved — only missing files added

Troubleshooting