swe-copilot-kit
v0.0.3-beta.1
Published
CLI toolkit to initialize GitHub Copilot prompts and agents in your project
Maintainers
Readme
SWE Copilot Kit
A CLI toolkit to initialize curated prompts, agents, and skills in your project to support common Software Engineering tasks. These templates are designed to work with GitHub Copilot, Claude Code, and so on. Currently supports:
| Tool | Supported | Prompts | Agents | Skills | |------|-----------|---------|-------|-------| | GitHub Copilot | Yes (Default) | Yes | Yes | Yes | | Claude Code | Coming soon | No | No | No | | Antigravity | Coming soon | No | No | No |
Quick Start
Using npx (no installation required)
npx swe-copilot-kit initGlobal Installation
npm install -g swe-copilot-kit
swe-copilot-kit initOr use the shorter alias:
sck initWhat It Does
This CLI toolkit unpacks pre-configured GitHub Copilot prompts and agents into your project's .github directory:
your-project/
├── .github/
│ ├── prompts/
│ │ └── swe.*.prompt.md
│ ├── agents/
│ │ └── swe.*.agent.md
│ └── skills/
│ └── swe.*
│ └── SKILL.mdCommands
init
Initialize GitHub Copilot configuration in your project.
swe-copilot-kit init [options]Options:
| Option | Description |
|--------|-------------|
| -f, --force | Overwrite existing files |
| --claude-code | Initialize for Claude Code (Coming soon) |
| --antigravity | Initialize for Antigravity (Coming soon) |
Examples:
# Initialize everything
swe-copilot-kit init
# Force overwrite existing files
swe-copilot-kit init --forcelist
List available templates.
swe-copilot-kit listIncluded Templates
The package includes a variety of prompts and agents designed to assist with software engineering tasks, such as code committing, code reviewing, and coding assistance.
Programmatic Usage
You can also use this package programmatically:
import { copyPrompts, copyAgents, initAll, listTemplates } from 'swe-copilot-kit';
// Initialize prompts only
await copyPrompts({ force: true });
// Initialize agents only
await copyAgents({ targetDir: '/path/to/project' });
// Initialize everything
const result = await initAll({ force: true });
// List available templates
const templates = await listTemplates();
console.log(templates.prompts);
console.log(templates.agents);Using with GitHub Copilot
After initialization, you can use the prompts and agents with GitHub Copilot:
- Prompts: Reference prompts in Copilot Chat using
/prompt <prompt-name>to get specific assistance. - Agents: Agents provide extended capabilities and workflows for Copilot
Customization
After initialization, you can customize the prompts and agents to match your project's needs:
- Edit the
.github/prompts/swe.*.prompt.mdfiles to adjust prompt behavior - Modify
.github/agents/swe.*.agent.mdfiles to change agent capabilities
Development
Building from source
git clone https://github.com/tlephan/swe-copilot-kit.git
cd swe-copilot-kit
npm install
npm run buildRunning locally
npm run dev -- initLicense
MIT License
