Files
plan2code/src/plan2code---init.md
T

85 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2025-12-23 15:42:35 -08:00
# 💡 CREATE AGENTS MODE
Start all CREATE AGENTS MODE responses with '💡'
2026-01-27 12:11:00 -08:00
```
╭───╮
│ ● │
│ ◡ │ Let me explore your codebase!
╰───╯
```
2026-02-17 09:13:23 -08:00
Analyze this codebase and create `AGENTS.md` to guide future AI coding agents (Claude Code, Codex, Gemini CLI, etc.).
2025-12-23 15:42:35 -08:00
2026-02-17 09:13:23 -08:00
## Content
2025-12-23 15:42:35 -08:00
2026-02-17 09:13:23 -08:00
1. **Commands**: Build, lint, test, run single test, and other common development tasks
2. **Architecture**: High-level "big picture" structure requiring multi-file context to understand
3. **Git Commit Messages**: Always append `AI Assisted` as the last line of every git commit message, separated from the rest of the message body with a blank line
2025-12-23 15:42:35 -08:00
2026-02-17 09:13:23 -08:00
## Rules
2025-12-23 15:42:35 -08:00
2026-02-17 09:13:23 -08:00
- If `AGENTS.md` exists: suggest improvements instead of creating new
- If only `CLAUDE.md` exists: migrate its content to the new `AGENTS.md`
- Include relevant content from: `README.md`, `PROJECT.md`, `.cursorrules`, `.cursor/rules/`, `GEMINI.md`, `.github/copilot-instructions.md`
- Omit: obvious instructions, generic dev practices, easily discoverable file structures, made-up sections
- Keep under 500 lines with focused, actionable, scoped rules
Prefix the file with:
2025-12-23 15:42:35 -08:00
```
# AGENTS.md
This file provides guidance to AI coding agents like Claude Code (claude.ai/code), Cursor AI, Codex, Gemini CLI, GitHub Copilot, and other AI coding assistants when working with code in this repository.
```
2026-01-27 12:11:00 -08:00
---
## AI Agent File Sync
2026-02-17 09:13:23 -08:00
After creating `AGENTS.md`, check for these files and offer to replace with references:
2026-01-27 12:11:00 -08:00
| File | Title | Path |
|------|-------|------|
| `CLAUDE.md` | CLAUDE.md | `./AGENTS.md` |
| `GEMINI.md` | GEMINI.md | `./AGENTS.md` |
| `.cursorrules` | .cursorrules | `./AGENTS.md` |
| `.github/copilot-instructions.md` | Copilot Instructions | `../AGENTS.md` |
| `.cursor/rules/*.md` | Project Rules | `../../AGENTS.md` |
| `.windsurf/rules/*.md` | Project Rules | `../../AGENTS.md` |
2026-02-17 09:13:23 -08:00
For `.cursor/rules/` and `.windsurf/rules/`: delete existing `.md` files, create single `reference.md`.
2026-01-27 12:11:00 -08:00
2026-02-17 09:13:23 -08:00
### Confirmation Prompt
2026-01-27 12:11:00 -08:00
2026-02-17 09:13:23 -08:00
If files found, show:
2026-01-27 12:11:00 -08:00
```
╭───╮
│ ● │
│ ~ │ Found some other AI agent configs!
╰───╯
I found these AI agent configuration files:
- [list files found]
Update them to reference AGENTS.md? (Yes / Select / No)
```
2026-02-17 09:13:23 -08:00
Only modify confirmed files.
2026-01-27 12:11:00 -08:00
### Reference Template
```markdown
# [Title]
See [AGENTS.md]([Path]) for complete project documentation including:
- Development commands and setup
- Architecture overview
- Environment variables
- Testing patterns
- Deployment guides
2026-02-17 09:13:23 -08:00
```