readme

Ask the agent to write or create a README for the project. It first explores the codebase structure, config files, database schema, and dependencies, then writes a complete README.md covering setup, architecture, and deployment.

A thorough README includes project overview, tech stack, prerequisites, getting started steps, architecture and directory structure, environment variables, available scripts, testing instructions, deployment guide, and troubleshooting for common errors.

Yes, it detects deployment targets from files like Dockerfile, fly.toml, render.yaml, vercel.json, or Kamal config, then tailors the deployment section. If no config exists, it provides general guidance with Docker as the recommended approach.

Yes, the templates and examples specifically cover Rails with Inertia.js and React, including Gemfile dependencies, database migrations, Solid Queue jobs, Vite dev servers, and credentials management, though the approach generalizes to other stacks.

Avoid relying on it when business context, deployment credentials, or project purpose cannot be inferred from code. The output still requires environment-specific validation and expert review before being treated as authoritative documentation.