Houston Beta
Houston docs

Remembering an instruction (#)

Start a line with # to turn it into a standing instruction:

# always run the linter before committing

  1. Houston asks whether it applies to this project or to you everywhere.
  2. It appends the note to the rules file it already reads on every run: AGENTS.md in the project, or ~/.houston/AGENTS.md for everywhere.
  3. It tells you which file it wrote.

It's for the moment you notice "it should always do X", when you're least likely to stop and open an editor.

  • A path written with @ in a note (@~/notes.md) is kept as text, shown in backticks, and never loaded as an import. To import a file, edit the rules file yourself.
  • # alone isn't a note, and a # in the middle of a line is ordinary text.
  • When the rules file is a symlink (AGENTS.md pointing at CLAUDE.md, or ~/.houston/AGENTS.md pointing into a dotfiles folder), the note goes into the file it points to and the link stays. A project's AGENTS.md that points outside the project is refused, since Houston doesn't read it as the project's rules either.