compass

README.md

compass๐Ÿ”—

Small scripts for rapidly orienting in a project area.

Each script is standalone: run individually for debugging, or compose into larger summaries (e.g. an agent's system prompt).

Conventions๐Ÿ”—

  • One concern per script.
  • Output is markdown, scoped so the top-level output fits under an h3 or smaller. Composers wrap in larger sections as needed.
  • If a script has nothing applicable to say, it stays silent (exits 0 with no output). Errors are different: surface those.
  • Bash for now. Nushell on the table once we want to pass structured data between scripts.

Scripts๐Ÿ”—

  • cwd-orient -- describes the current working directory.
  • git-orient -- describes the surrounding git repo, if any.

README.md ยท 732 B ยท 2f34e08863