Eulix Documentation

Start here to find where things are. Each folder has an Overview.md to read first.

Where to start

New to Eulix? Read Welcome.md first, then Installation.md.

If you want to… Read
Install Eulix Installation.md
Understand how Eulix is put together eulix-cli/Overview.md (the program you run), then libeulix/Overview.md (the engine)
Run the parser or read its output files eulix-parser/Overview.md
See how a question becomes an answer eulix-cli/query/retrieval/Overview.md
Connect an AI coding agent eulix-cli/mcp/Overview.md
Explore a call graph in the browser vizEulize/Overview.md
Check a bug before filing it Known-Issues/Overview.md

Folders

Folder Covers
libeulix/ The Rust analysis library: public API, knowledge-base schema, analysis passes, PRISM v1 and v2, and their measured call-graph accuracy.
eulix-parser/ The command-line parser: pipeline, output files, performance notes.
eulix-embed/ The Python embedding tool: chunking, pipeline, ONNX and PyTorch backends, binary file format, query server.
eulix-cli/ The Go eulix program, one page per package: Cli, Config, Cache, Checksum, Embeddings, Llm, Assets, Fixers, Utils. Sub-folders: mcp/ (MCP server), query/ (router, classifier, prompts, strip, and retrieval/ with the two engines), tui/ (chat and history screens).
vizEulize/ The browser call-graph explorer.
Architecture/ Cross-cutting designs: Spill to Disk, Incremental Parsing, the Version Benchmark that compares two eulix versions, and how the call-graph benchmark scores.
Known-Issues/ Open bugs and limitations by area, plus a record of fixed issues.

Not written yet

eulix-lsp, and more pages in Architecture/ (for example retrieval routing). See each subsystem’s own README in the repository meanwhile.

Conventions

  • Folder and file names are capitalized and hyphenated, except subsystem folders, which keep the code’s name (eulix-cli, vizEulize).
  • Every page records the commit it was last checked against (currently ad744e9).
  • Problems found while documenting are in Known-Issues; scripts that reproduce them are in ../scripts/known_issues/.