Skip to content

AGENTS.md

Latest commit

 

History

History
77 lines (54 loc) · 2.53 KB

AGENTS.md

File metadata and controls

77 lines (54 loc) · 2.53 KB

ansari-backend - AI Agent Instructions

Note: This file follows the AGENTS.md standard for cross-tool compatibility with Cursor, GitHub Copilot, and other AI coding assistants. A Claude Code-specific version is maintained in CLAUDE.md.

Project Overview

This project uses Codev for AI-assisted development.

Available Protocols

  • SPIR: Multi-phase development with consultation (codev/protocols/spir/protocol.md)
  • TICK: Fast autonomous implementation (codev/protocols/tick/protocol.md)
  • EXPERIMENT: Disciplined experimentation (codev/protocols/experiment/protocol.md)
  • MAINTAIN: Codebase maintenance (codev/protocols/maintain/protocol.md)

Key Locations

  • Specs: codev/specs/ - Feature specifications (WHAT to build)
  • Plans: codev/plans/ - Implementation plans (HOW to build)
  • Reviews: codev/reviews/ - Reviews and lessons learned
  • Protocols: codev/protocols/ - Development protocols

Quick Start

  1. For new features, start with the Specification phase
  2. Create exactly THREE documents per feature: spec, plan, and review
  3. Follow the protocol phases as defined in the protocol files
  4. Use multi-agent consultation when specified

File Naming Convention

Use sequential numbering with descriptive names:

  • Specification: codev/specs/0001-feature-name.md
  • Plan: codev/plans/0001-feature-name.md
  • Review: codev/reviews/0001-feature-name.md

Git Workflow

NEVER use git add -A or git add . - Always add files explicitly.

Commit messages format:

[Spec 0001] Description of change
[Spec 0001][Phase: implement] feat: Add feature

CLI Commands

Codev provides three CLI tools:

  • codev: Project management (init, adopt, update, doctor)
  • af: Agent Farm orchestration (start, spawn, status, cleanup)
  • consult: AI consultation for reviews (pr, spec, plan)

For complete reference, see codev/resources/commands/:

  • codev/resources/commands/overview.md - Quick start
  • codev/resources/commands/codev.md - Project commands
  • codev/resources/commands/agent-farm.md - Agent Farm commands
  • codev/resources/commands/consult.md - Consultation commands

Configuration

Agent Farm is configured via af-config.json at the project root. Created during codev init or codev adopt. Override via CLI flags: --architect-cmd, --builder-cmd, --shell-cmd.

{
  "shell": {
    "architect": "claude",
    "builder": "claude",
    "shell": "bash"
  }
}

For More Info

Read the full protocol documentation in codev/protocols/.