Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/pr-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,30 @@ jobs:
test -d ./test-output-antigravity/.agent/skills
echo "Antigravity platform: OK"

- name: Smoke test - Gemini platform
run: |
node bin/cli.js --platform gemini ./test-output-gemini
test -d ./test-output-gemini/_sam
test -d ./test-output-gemini/.gemini/skills
echo "Gemini platform: OK"

- name: Smoke test - Copilot platform
run: |
node bin/cli.js --platform copilot ./test-output-copilot
test -d ./test-output-copilot/_sam
test -d ./test-output-copilot/copilot-integration
test -f ./test-output-copilot/copilot-integration/instructions.md
echo "Copilot platform: OK"

- name: Smoke test - All platforms
run: |
node bin/cli.js --platform all ./test-output-all
test -d ./test-output-all/_sam
test -d ./test-output-all/.claude/commands/sam
test -d ./test-output-all/.cursor/rules
test -d ./test-output-all/.agent/skills
test -d ./test-output-all/.gemini/skills
test -d ./test-output-all/copilot-integration
echo "All platforms: OK"

- name: Verify templates in sync
Expand Down
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Downloads](https://img.shields.io/npm/dm/sam-agents.svg)](https://www.npmjs.com/package/sam-agents)

**Autonomous TDD agent system for Claude Code, Cursor, and Antigravity.**
**Autonomous TDD agent system for Claude Code, Cursor, Gemini CLI, GitHub Copilot, and Antigravity.**

SAM orchestrates a team of specialized AI agents that transform your PRD into working, tested code using strict Test-Driven Development (RED-GREEN-REFACTOR).

Expand All @@ -18,6 +18,8 @@ npx sam-agents
npx sam-agents --platform claude # Claude Code
npx sam-agents --platform cursor # Cursor IDE
npx sam-agents --platform antigravity # Google Antigravity
npx sam-agents --platform gemini # Gemini CLI
npx sam-agents --platform copilot # GitHub Copilot
npx sam-agents --platform all # All platforms
```

Expand All @@ -27,6 +29,8 @@ npx sam-agents --platform all # All platforms
|----------|-----------------|--------------|
| **Claude Code** | `npx sam-agents --platform claude` | `/sam:` commands |
| **Cursor** | `npx sam-agents --platform cursor` | `@agent` mentions |
| **Gemini CLI** | `npx sam-agents --platform gemini` | `.gemini/skills/` |
| **GitHub Copilot** | `npx sam-agents --platform copilot` | `copilot-integration/` |
| **Antigravity** | `npx sam-agents --platform antigravity` | `/sam-` skills |

## Why SAM?
Expand All @@ -37,27 +41,29 @@ npx sam-agents --platform all # All platforms
| **BYOA** | Use your own AI subscription | Pay per API call (5-10x cost) |
| **Transparency** | Watch agents work in real-time | Black box |
| **Autonomous** | Minimal intervention after PRD | Constant hand-holding |
| **Multi-Platform** | Claude Code + Cursor + Antigravity | Single platform lock-in |
| **Multi-Platform** | Claude Code + Cursor + Gemini + Copilot + Antigravity | Single platform lock-in |

## Available Agents

| Agent | Role | Claude Code | Cursor | Antigravity |
|-------|------|-------------|--------|-------------|
| **SAM** | Orchestrator | `/sam:core:agents:sam` | `@sam` | `/sam-orchestrator` |
| **Atlas** | System Architect | `/sam:sam:agents:atlas` | `@atlas` | `/sam-atlas` |
| **Titan** | Test Architect (RED) | `/sam:sam:agents:titan` | `@titan` | `/sam-titan` |
| **Dyna** | Developer (GREEN) | `/sam:sam:agents:dyna` | `@dyna` | `/sam-dyna` |
| **Argus** | Code Reviewer (REFACTOR) | `/sam:sam:agents:argus` | `@argus` | `/sam-argus` |
| **Cosmo** | CSS Reviewer (web apps) | `/sam:sam:agents:cosmo` | `@cosmo` | `/sam-cosmo` |
| **Sage** | Technical Writer | `/sam:sam:agents:sage` | `@sage` | `/sam-sage` |
| **Iris** | UX Designer | `/sam:sam:agents:iris` | `@iris` | `/sam-iris` |
| Agent | Role | Claude Code | Cursor | Gemini | Copilot | Antigravity |
|-------|------|-------------|--------|--------|---------|-------------|
| **SAM** | Orchestrator | `/sam:core:agents:sam` | `@sam` | `sam-orchestrator` | `Act as sam-orchestrator` | `/sam-orchestrator` |
| **Atlas** | System Architect | `/sam:sam:agents:atlas` | `@atlas` | `sam-atlas` | `Act as sam-atlas` | `/sam-atlas` |
| **Titan** | Test Architect (RED) | `/sam:sam:agents:titan` | `@titan` | `sam-titan` | `Act as sam-titan` | `/sam-titan` |
| **Dyna** | Developer (GREEN) | `/sam:sam:agents:dyna` | `@dyna` | `sam-dyna` | `Act as sam-dyna` | `/sam-dyna` |
| **Argus** | Code Reviewer (REFACTOR) | `/sam:sam:agents:argus` | `@argus` | `sam-argus` | `Act as sam-argus` | `/sam-argus` |
| **Cosmo** | CSS Reviewer (web apps) | `/sam:sam:agents:cosmo` | `@cosmo` | `sam-cosmo` | `Act as sam-cosmo` | `/sam-cosmo` |
| **Sage** | Technical Writer | `/sam:sam:agents:sage` | `@sage` | `sam-sage` | `Act as sam-sage` | `/sam-sage` |
| **Iris** | UX Designer | `/sam:sam:agents:iris` | `@iris` | `sam-iris` | `Act as sam-iris` | `/sam-iris` |

## The TDD Pipeline

| Platform | Command |
|----------|---------|
| Claude Code | `/sam:core:workflows:autonomous-tdd` |
| Cursor | `@sam-tdd` |
| Gemini CLI | `sam-tdd-pipeline` |
| GitHub Copilot | `Run SAM TDD pipeline` |
| Antigravity | `/sam-tdd-pipeline` |

### Pipeline Phases
Expand All @@ -81,6 +87,8 @@ your-project/
│ └── core/workflows/ # TDD pipeline workflow
├── .claude/commands/sam/ # Claude Code skills
├── .cursor/rules/ # Cursor rules
├── .gemini/skills/ # Gemini CLI skills
├── copilot-integration/ # GitHub Copilot instructions
└── .agent/skills/ # Antigravity skills
```

Expand All @@ -90,6 +98,8 @@ your-project/
- One of:
- [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code)
- [Cursor](https://cursor.com)
- [Gemini CLI](https://github.com/google-gemini/gemini-cli)
- [GitHub Copilot](https://github.com/features/copilot)
- [Google Antigravity](https://antigravity.google)

## Contributing
Expand Down
60 changes: 60 additions & 0 deletions _sam/docs/SAM_COPILOT_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# SAM Copilot Integration Guide

## Overview
SAM (Smart Agent Manager) integrates with GitHub Copilot Chat, enabling developers to leverage autonomous TDD workflows within VS Code and other Copilot-enabled IDEs.

## Installation

```bash
npx sam-agents --platform copilot
```

This generates a `copilot-integration/` directory containing:
- `instructions.md` — High-level instructions for GitHub Copilot
- `agents/` — Detailed instruction files for every SAM agent
- `references/` — Project design standards and workflows

## How It Works

GitHub Copilot doesn't have a native plugin/skill system like Claude Code or Cursor. Instead, SAM generates markdown instruction files that you can reference in Copilot Chat conversations.

### Invoking Agents

In GitHub Copilot Chat, ask Copilot to adopt a SAM agent persona:

```
"Act as sam-atlas and review this PRD."
"Act as sam-titan and write failing tests for login.ts."
"Act as sam-dyna and implement the login feature to pass the tests."
"Act as sam-argus and review the code changes."
```

### Running the TDD Pipeline

```
"Run the SAM TDD pipeline for this feature."
```

Or point Copilot to the pipeline workflow:
```
"Follow the instructions in copilot-integration/agents/sam-tdd-pipeline.md"
```

## Available Agents

| Agent | Invocation | Role |
|-------|-----------|------|
| SAM Orchestrator | `Act as sam-orchestrator` | Pipeline coordinator |
| Atlas | `Act as sam-atlas` | System Architect |
| Titan | `Act as sam-titan` | Test Architect (RED) |
| Dyna | `Act as sam-dyna` | Developer (GREEN) |
| Argus | `Act as sam-argus` | Code Reviewer (REFACTOR) |
| Cosmo | `Act as sam-cosmo` | CSS Reviewer |
| Sage | `Act as sam-sage` | Technical Writer |
| Iris | `Act as sam-iris` | UX Designer |

## Tips

- Point Copilot to `copilot-integration/instructions.md` at the start of a session for full context
- Reference specific agent files for deep persona adoption
- Works best with GitHub Copilot Chat in VS Code
71 changes: 71 additions & 0 deletions _sam/docs/SAM_COPILOT_USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# SAM Copilot Usage Examples

## Quick Start

### 1. Install SAM for Copilot
```bash
npx sam-agents --platform copilot
```

### 2. Open Copilot Chat in VS Code

### 3. Point Copilot to SAM Instructions
```
Please read copilot-integration/instructions.md and follow the SAM agent system.
```

## Usage Examples

### Architecture Review
```
Act as sam-atlas. Review the architecture of this project and identify any concerns
with the current structure.
```

### Writing Tests (RED Phase)
```
Act as sam-titan. Write failing tests for the user authentication feature based on
the acceptance criteria in the PRD.
```

### Implementation (GREEN Phase)
```
Act as sam-dyna. Implement the minimum code needed to make the failing authentication
tests pass.
```

### Code Review (REFACTOR Phase)
```
Act as sam-argus. Review the authentication implementation for code quality,
best practices, and potential improvements.
```

### CSS Review
```
Act as sam-cosmo. Review the CSS in the login page for consistency, spacing scale
violations, and styling anti-patterns.
```

### UX Review
```
Act as sam-iris. Review the UX of the login flow and suggest improvements for
usability and accessibility.
```

### Documentation
```
Act as sam-sage. Generate API documentation for the authentication module.
```

### Full TDD Pipeline
```
Act as sam-orchestrator. Run the full TDD pipeline for the feature described in prd.md.
Follow the workflow in copilot-integration/agents/sam-tdd-pipeline.md.
```

## Tips for Best Results

1. **Be specific** — Reference file paths and feature names
2. **One agent at a time** — Switch personas explicitly between phases
3. **Reference the instructions** — Point Copilot to the agent markdown files for deeper context
4. **Follow TDD order** — RED (tests first) → GREEN (implementation) → REFACTOR (review)
Loading