Files
ralph-vibe/CLAUDE.md
2026-01-10 11:59:27 +00:00

1.8 KiB

Claude Code Configuration

Project Context

This is the Ralph PRD Generator - a CLI tool that generates Ralph Method project scaffolds.

Read PROMPT.md for full requirements. Read prd.json for feature tracking. Append progress to progress.txt after each significant change.

Key Files

  • PROMPT.md: Full specification - this is your primary reference
  • prd.json: Feature tracking with acceptance criteria
  • progress.txt: Append-only progress log
  • docs/framework.md: Ralph Method framework reference
  • docs/guide.md: Step-by-step guide reference

Tech Stack

  • TypeScript with strict mode
  • Node.js 20+
  • Commander.js for CLI
  • Inquirer.js for prompts
  • Anthropic SDK for Claude
  • Native fetch for Perplexity
  • Vitest for testing
  • tsup for building

Working Rules

  1. Always run tests before committing
  2. Never commit failing code
  3. Update prd.json when features complete by setting passes to true
  4. Use conventional commit messages
  5. Make reasonable decisions - do not ask questions

Commands

  • Build: npm run build
  • Test: npm run test
  • Lint: npm run lint
  • All: npm run build && npm run test && npm run lint
  • Dev: npm run dev

Directory Structure

src/ index.ts # CLI entry point commands/ # Command handlers init.ts new.ts validate.ts research.ts clients/ # API clients claude.ts perplexity.ts generators/ # Generation logic architecture.ts specification.ts prd.ts scaffold.ts prompts/ # Prompt templates templates.ts types/ # TypeScript types index.ts utils/ # Utilities config.ts files.ts logger.ts

API Keys for Testing

During development, use environment variables:

  • CLAUDE_API_KEY
  • PERPLEXITY_API_KEY

Never commit real keys. Use .env.local which is gitignored.