For AI agents

ef ships artifacts for coding agents alongside its code. This page lists them, says where each lives in the repository, and points at the machine-readable copies of this documentation.

Skills

Skills are folders holding a SKILL.md (the Agent Skills format): a description that tells an agent when to use it and a body with the procedure. Install one into your agent with gh skill (any host: --agent claude-code, copilot, cursor, codex, gemini), or use the copy bundled in the wheel.

ef-architecture

Developer skill: the target architecture of the ef (Embedding Flow) package. Load at the start of any non-trivial task in the ef repository — refactoring, adding the Embedder/Segmenter facades, the Corpus abstraction, the ArtifactGraph indexing core, or the “ready search” surface. Covers the five-layer model, the core contracts, the light/heavy progressive-disclosure split, and the hard boundaries. Trigger on “work on ef”, “refactor ef”, “implement the embedder/segmenter/corpus/artifact graph”, “ef search”.

gh skill install thorwhalen/ef ef-architecture --agent claude-code

Source: skills/ef-architecture.

Instruction files

Files agents read before working in this repository.

Machine-readable documentation

This site publishes the same documentation in forms that fit an agent’s context window:

  • llms.txt: an index of every page with a one-line description (llms.txt format)

  • ef.md: the whole documentation as one Markdown file

  • <page>.html.md: a rendered Markdown twin of every page, advertised from each page’s <head> with <link rel="alternate" type="text/markdown">

  • objects.inv: the Sphinx inventory: a symbol-to-URL index (sphobjinv convert plain objects.inv -)