LLM Guides

dexkit ships LLM-optimized reference docs for each pattern. Install them as AGENTS.md files so AI coding agents automatically get the right context when working in your app directories.

Installation

rake dex:guides

  app/operations/AGENTS.md      ← OPERATION.md
  app/events/AGENTS.md          ← EVENT.md
  app/event_handlers/AGENTS.md  ← EVENT.md
  app/forms/AGENTS.md            (skipped — directory not found)
  app/queries/AGENTS.md         ← QUERY.md

3 guide(s) installed.

The task only writes to directories that already exist and stamps each file with the installed dexkit version. The event guide (covering both events and handlers) is installed to app/events/ and app/event_handlers/ when either exists.

Keeping guides in sync

Re-run after upgrading dexkit to sync the guides. Files generated by dexkit (detected via a marker comment) are overwritten safely. If an AGENTS.md was written by hand, the task skips it with a warning – use FORCE=1 to overwrite anyway.

Custom paths

Override paths for non-standard directory names:

rake dex:guides OPERATIONS_PATH=app/services

Env var	Default
OPERATIONS_PATH	app/operations
EVENTS_PATH	app/events
EVENT_HANDLERS_PATH	app/event_handlers
FORMS_PATH	app/forms
QUERIES_PATH	app/queries