mix fathom.install (fathom v0.1.0)

Copy Markdown View Source

Sets up the surrounding project so that agents working in it find and use the program database.

mix fathom.install

It does three things:

  • writes the schema and a set of worked queries into AGENTS.md, between <!-- fathom:begin --> and <!-- fathom:end --> markers so re-running the task updates the section in place rather than appending a second copy
  • adds .fathom/ to .gitignore, since the database is derived
  • tells you what to add to mix.exs, which it will not edit itself

Options

  • --guide - path to the agent instructions file. Defaults to AGENTS.md, or CLAUDE.md if that exists and AGENTS.md does not.
  • --database - path the guide should point at. Defaults to .fathom/program.db.