npm package: @fyow/copilot-everything
Description: Everything you need for GitHub Copilot CLI - agents, skills, instructions, and hooks configurations
Author: fyow
Latest version: 1.0.14

# @fyow/copilot-everything

[![npm version](https://img.shields.io/npm/v/@fyow/copilot-everything.svg)](https://www.npmjs.com/package/@fyow/copilot-everything)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
![Node.js](https://img.shields.io/badge/-Node.js-339933?logo=node.js&logoColor=white)
![TypeScript](https://img.shields.io/badge/-TypeScript-3178C6?logo=typescript&logoColor=white)

**Everything you need for GitHub Copilot CLI** - agents, skills, instructions, and hooks configurations.

Production-ready configurations evolved from 10+ months of intensive daily use building real products.

---

## Quick Start

```bash
# Install globally
npm install -g @fyow/copilot-everything

# Update to latest version
copilot-everything update

# Initialize in your project
cd your-project
copilot-everything init --ai copilot

# Start using with Copilot CLI
copilot
/agent planner
```

---

## What's Included

### 🤖 Custom Agents (9)

| Agent | Purpose | Invoke |
|-------|---------|--------|
| planner | Implementation planning | /agent planner |
| architect | System design decisions | /agent architect |
| tdd-guide | Test-driven development | /agent tdd-guide |
| code-reviewer | Code quality review | /agent code-reviewer |
| security-reviewer | Security analysis | /agent security-reviewer |
| build-error-resolver | Fix build/type errors | /agent build-error-resolver |
| e2e-runner | Playwright E2E testing | /agent e2e-runner |
| refactor-cleaner | Dead code cleanup | /agent refactor-cleaner |
| doc-updater | Documentation sync | /agent doc-updater |

### 📚 Skills (8)

| Skill | Description |
|-------|-------------|
| backend-patterns | Backend architecture, API design, database patterns |
| clickhouse-io | ClickHouse analytics patterns and optimization |
| coding-standards | Universal coding standards and best practices |
| frontend-patterns | React, Next.js, state management patterns |
| project-guidelines-example | Example project-specific skill template |
| security-review | Security checklist and vulnerability patterns |
| tdd-workflow | Test-driven development workflow |
| verification-loop | Code verification and quality gates |

### 📝 Instructions (5)

Path-specific coding guidelines automatically applied:

- coding-style.instructions.md - For **/*.ts,**/*.tsx,**/*.js,**/*.jsx
- security.instructions.md - For code files
- testing.instructions.md - For test files
- git-workflow.instructions.md - For all files
- performance.instructions.md - For all files

### 🪝 Hooks

Pre-configured hooks for sessionStart, sessionEnd, preToolUse, postToolUse.

---

## CLI Usage

```bash
copilot-everything <command> [options]
```

### Commands

| Command | Description |
|---------|-------------|
| init | Initialize Copilot configurations in current directory |
| update | Update copilot-everything to latest version |

### Options

| Option | Description |
|--------|-------------|
| --ai type | Target AI platform: copilot (default), claude, or all |
| --force | Overwrite existing files |
| --force-mcp | Overwrite ~/.copilot/mcp-config.json (contains API keys) |
| -y, --yes | Skip confirmation prompts for --force flags |
| --skip-agents | Skip agent installation |
| --skip-skills | Skip skills installation |
| --skip-hooks | Skip hooks installation |
| -h, --help | Show help message |
| -v, --version | Show version number |

### Examples

```bash
# Initialize with Copilot CLI configs
copilot-everything init

# Initialize with force overwrite
copilot-everything init --force

# Overwrite MCP config (API keys will be auto-filled from environment)
copilot-everything init --force-mcp

# Skip confirmation prompts (for CI/scripts)
copilot-everything init --force-mcp -y

# Skip certain components
copilot-everything init --skip-hooks --skip-skills

# Initialize for both Copilot and Claude
copilot-everything init --ai all
```

---

## Installed Structure

After running copilot-everything init, your project will have:

```
your-project/
├── AGENTS.md                           # Top-level agent instructions
└── .github/
    ├── copilot-instructions.md         # Repository-wide instructions
    ├── agents/
    │   ├── planner.agent.md
    │   ├── architect.agent.md
    │   └── ... (9 agents)
    ├── instructions/
    │   ├── coding-style.instructions.md
    │   ├── security.instructions.md
    │   └── ... (5 instructions)
    ├── skills/
    │   ├── backend-patterns/SKILL.md
    │   ├── coding-standards/SKILL.md
    │   └── ... (8 skills)
    └── hooks/
        └── project-hooks.json
```

---

## Compatibility

| Platform | Support Level | Notes |
|----------|--------------|-------|
| **GitHub Copilot CLI** | ✅ Full | All features (agents, skills, hooks, instructions) |
| **Claude Code** | ✅ Full | Uses same .github/ structure |
| **VS Code Copilot Chat** | ⚠️ Partial | Instructions only; agents/hooks not supported |
| **Node.js** | >= 18.0.0 | Required for CLI |

### Using in VS Code Copilot Chat

VS Code Copilot Chat has different tool capabilities than Copilot CLI:

1. **Custom agents** (`.agent.md`) are **not supported** in VS Code
2. **Hooks** are **not supported** in VS Code
3. **Instructions** are loaded automatically ✅
4. **Skills** can be referenced manually by:
   - Attaching the skill file to your chat
   - Saying: "Follow the workflow in `.github/skills/tdd-workflow/SKILL.md`"

VS Code uses its own built-in tools (`read_file`, `run_in_terminal`, etc.) which work automatically.

---

## MCP Server Configuration

The init command installs a comprehensive MCP config template to `~/.copilot/mcp-config.json` with 20+ servers:

- **AI/Docs**: context7, next-devtools, cloudflare-docs
- **Browser**: playwright, chrome-devtools, puppeteer
- **DevOps**: github, vercel, railway, docker, sentry
- **Database**: postgres, sqlite, redis, supabase
- **Utilities**: memory, firecrawl, fetch, filesystem, git, sequential-thinking

### Auto-fill Environment Variables

When installing MCP config, the CLI automatically detects and substitutes environment variables:

```bash
# Set your API keys in environment
export GITHUB_TOKEN=ghp_xxx
export FIRECRAWL_API_KEY=fc_xxx
export CONTEXT7_API_KEY=xxx

# Install with auto-fill
copilot-everything init --force-mcp

# Output:
#    ✅ MCP config: installed to ~/.copilot/mcp-config.json
#       🔑 Auto-filled from environment: GITHUB_TOKEN, FIRECRAWL_API_KEY, CONTEXT7_API_KEY
#       📝 Need to configure: SUPABASE_PROJECT_REF, POSTGRES_CONNECTION_STRING, ...
```

Supported environment variables:
- `GITHUB_TOKEN` - GitHub Personal Access Token
- `CONTEXT7_API_KEY` - Context7 API key
- `FIRECRAWL_API_KEY` - Firecrawl API key
- `SUPABASE_PROJECT_REF` - Supabase project reference
- `POSTGRES_CONNECTION_STRING` - PostgreSQL connection string
- `SQLITE_DB_PATH` - SQLite database path
- `REDIS_URL` - Redis connection URL
- `WORKSPACE_PATH` - Filesystem workspace path

---

## Customization

After installation, customize the configs for your project:

1. **Edit copilot-instructions.md** - Add project-specific context
2. **Modify agents** - Adjust agent prompts for your workflow
3. **Add skills** - Create new skills in .github/skills/your-skill/SKILL.md
4. **Update instructions** - Add path-specific rules in .github/instructions/

---

## Migration from Claude Code

See [MIGRATION-GUIDE.md](docs/MIGRATION-GUIDE.md) for detailed migration instructions.

---

## Contributing

Contributions welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) first.

---

## License

MIT

---

## Credits

Based on the "Everything Claude Code" configurations by [@affaanmustafa](https://github.com/affaan-m).