WARP.md

retort — Warp Instructions

Retort framework for multi-tool AI agent team orchestration, sync generation, and quality-gated workflows.

Project Context

• Languages: javascript, yaml, markdown

• Backend: node.js

• ORM: none

• Database: none

• Messaging: none

• Architecture: monolith

• API Style: mixed

• Default Branch: main

  • Phase: active

Quick Commands

Action	Command
Install dependencies	See stack-specific section below
Build	See stack-specific section below
Test	See stack-specific section below
Lint	See stack-specific section below
Format	See stack-specific section below

Coding Standards

• Write minimal, focused diffs — change only what is necessary.
• Maintain backwards compatibility; document breaking changes.
• Every behavioral change must include tests.
• Never commit secrets, API keys, or credentials.
• Prefer explicit error handling over silent failures.
• Use the strongest type safety available for the language.
  • Follow conventional commit convention.
  • Branch strategy: github-flow.

Authentication & Authorization

Provider: custom-jwt, strategy: jwt-bearer. RBAC is enforced.

API Conventions

• Versioning: url-segment
• Pagination: cursor
• Response format: envelope
• Rate limiting is enabled

Testing

• Unit: vitest

• Integration: vitest

• Coverage target: 80%

Always run the full test suite before creating a pull request.

Documentation

• PRDs: docs/prd/

• ADRs: docs/architecture/decisions/

• API Spec: docs/api/

• Technical Spec: docs/architecture/specs/

• Brand Guide: .agentkit/spec/brand.yaml — AgentKit Forge (primary: #1976D2)

• See AGENTS.md for universal agent instructions.

• See QUALITY_GATES.md for quality gate definitions.

• See RUNBOOK_AI.md for recovery procedures.

Safety Rules

1. Never commit secrets, API keys, or credentials
2. Never force-push to main
3. Never run destructive commands without confirmation
4. Always run tests before creating a PR
5. Always document breaking changes
6. Always write tests for new functionality