plan2code/AGENTS.md

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.

Project Overview

Plan2Code is a structured 4-step workflow methodology for AI-assisted software development. It provides prompt templates that can be installed globally or per-project for various AI coding tools (Claude Code, Cursor, Copilot, Continue, Windsurf, Codeium).

Version: Check version.json for current version Author: Justin Parker License: MIT

How to Use This File

This file is an index — each section below contains a brief summary and a link to a detail file in .agents-docs/. Read only the sections relevant to your current task. Full details (commands, tables, file lists) are in the linked files. The sections "Git Commit Messages" and "Project Overview" are fully inline here.

Architecture

High-level directory structure, key files, workflow prompt inventory, and file naming conventions.

Details: Architecture

Plan2Code Loop

Autonomous CLI tool (plan2code-loop/) that implements specs by looping through tasks. Covers loop architecture, modes (one-task vs one-phase), completion markers, and key source files.

Details: Plan2Code Loop

Plan2Code Metrics

Recursive self-improvement toolchain (plan2code-metrics/) for collecting run metrics, aggregating by prompt generation, diagnosing weak steps, and proposing prompt edits.

Details: Plan2Code Metrics

Development Commands

Build commands, installer menu options, how the installer generates platform-specific files, platform format table, and how to edit workflow prompts.

Details: Development Commands

Code Style & Gotchas

Language/toolchain conventions for install.js vs TypeScript packages, and pitfalls to avoid (version sync, .gitignore pre-flight, character limits, User Feedback table format).

Details: Code Style & Gotchas

Git Commit Messages

• Commit message format:

  <description of what this commit is about>
  
  <JIRA-Ticket-ID>
  AI Assisted
  

• JIRA ticket ID: Derive the ticket ID from the current branch name. The branch format is <prefix>/<TICKET-ID>-description, where the ticket ID is an uppercase project key followed by a hyphen and integer (e.g., PCWEB-10968, ABC-123).
• AI Assisted footer: Always the last line of every commit message.
• Commit paths: This is enforced across all commit surfaces:
  • Loop task mode: createTaskCommit() in plan2code-loop/src/utils/git.ts appends the footer automatically
  • Loop phase mode: Prompt template instructs the LLM to follow the format above
  • Implement mode: User-facing commit suggestions in src/plan2code-3--implement.md follow the format above
• Init workflow: src/plan2code---init.md generates AGENTS.md files with a Git Commit Messages section that includes this convention by default

Mascot

The project has a mascot called "Planny" - an ASCII art robot that appears in installer output and workflow prompts. Mascot variants are defined in MASCOT constant in install.js and appear in workflow markdown files.

   ╭───╮
   │ ● │
   │ ◡ │
   ╰───╯