Eulix documentation
Every page here is rendered from the docs/ folder of the repository, so it stays in step with the code. 69 documents in 8 sections.
No document title or summary matches that filter.
General4
- Welcome to EulixEulix turns a code repository into something you can ask questions of: where a function is defined, who calls it, how a feature works, what depends on…docs/Welcome.md
- InstallationThis guide shows how to install Eulix with the install script, and how to build it from source.docs/Installation.md
- Eulix DocumentationStart here to find where things are. Each folder has an Overview.md to read first.docs/README.md
- ScriptsAudited 2026-11-04 on branch pre-release-fixes (ad744e9). All scripts were renamed to snake_case on 2026-11-04. The "Former name" column is the old name…docs/scripts.md
eulix-cli31stablev0.9.0
- MCP ServerThe mcp package lets AI coding agents ask Eulix questions about your code over the Model Context Protocol.docs/eulix-cli/mcp/Overview.md
- eulix-clieulix-cli is the Go program you actually type, eulix. It runs the parser and the embedding tool, answers questions about your code, and ties every other…docs/eulix-cli/Overview.md
- queryThe query package is the router. It decides how to answer each question: directly from the knowledge base, or by retrieving code and building a prompt for…docs/eulix-cli/query/Overview.md
- retrievalThe retrieval package chooses which pieces of code to show the language model for a given question.docs/eulix-cli/query/retrieval/Overview.md
- tuiThe tui package is the full-screen terminal interface of eulix chat: a chat screen and a history browser, built on the Bubble Tea framework.docs/eulix-cli/tui/Overview.md
- MCP Anchors And ScoringThis page explains what an anchor is, how anchors are found, and how the server scores a result to decide whether to keep searching.docs/eulix-cli/mcp/Anchors-And-Scoring.md
- assetsThe assets package holds the programs that travel inside the eulix binary, unpacks them on first use, and checks they have not been tampered with.docs/eulix-cli/Assets.md
- cacheThe cache package keeps a history of the questions you asked and the answers you got.docs/eulix-cli/Cache.md
- Chat ScreenThis page explains how the chat screen holds its state, reacts to input, lays itself out, and turns a typed question into a displayed answer.docs/eulix-cli/tui/Chat-Screen.md
- checksumThe checksum package works out how much of a project has changed since the last analysis, without reading any file contents.docs/eulix-cli/Checksum.md
- classifierThe classifier package puts each question into one of 21 types, using fixed rules and no model.docs/eulix-cli/query/Classifier.md
- cliThe cli package defines every eulix command and the set-up wizard behind eulix init.docs/eulix-cli/Cli.md
- configThe config package reads eulix.toml, fills in defaults, keeps every value inside a safe range, and finds API keys.docs/eulix-cli/Config.md
- EHNAS Augmentation LayersThis page explains the three extra layers the EHNAS engine adds to the shared search: twin search, a Monte Carlo walk, and novelty packing, plus its…docs/eulix-cli/query/retrieval/Ehnas-Augmentation.md
- embeddingsThe embeddings package starts the Python embedding tool and talks to it, so that a question can be turned into a vector while you wait.docs/eulix-cli/Embeddings.md
- Retrieval Engines: ETIYA and EHNASETIYA and EHNAS, the two retrieval engines in Eulix: how they differ, when to pick each, and how to switch with one line in eulix.toml.docs/eulix-cli/query/retrieval/Engines.md
- fixersThe fixers package contains two repair tools for the binary files in .eulix/. They are written but not connected to any command today.docs/eulix-cli/Fixers.md
- History ViewerThis page describes the screen that lists past questions and shows one in full, and the problems I found in how it behaves.docs/eulix-cli/tui/History-Viewer.md
- Retrieval Index LoadingThis page explains how the retrieval engine turns the files in .eulix/ into in-memory structures it can search quickly.docs/eulix-cli/query/retrieval/Index-Loading.md
- llmThe llm package sends a prompt to a language-model provider and returns the reply.docs/eulix-cli/Llm.md
- Markdown RenderingThis page explains how the chat screen turns the Markdown a language model writes into styled, correctly wrapped terminal text.docs/eulix-cli/tui/Markdown-Rendering.md
- MCP Memory And Lexical FallbackThis page covers the two supporting parts of the MCP retrieval cascade: the small per-project memory, and the plain text search that runs when everything…docs/eulix-cli/mcp/Memory-And-Lexical-Fallback.md
- mmapThe mmap sub-package decodes very large JSON files through a memory mapping, with a separate implementation for each operating system, and gives the…docs/eulix-cli/query/retrieval/Mmap.md
- promptsThe prompt builders wrap the retrieved context in instructions that make the model reason carefully and admit what it cannot see.docs/eulix-cli/query/Prompts.md
- MCP Retrieval CascadeThis page explains how the MCP server decides how to search for a question, and when to stop.docs/eulix-cli/mcp/Retrieval-Cascade.md
- Retrieval Search PipelineThis page walks through the first half of retrieval: understanding the question, spending the token budget, and gathering and scoring candidate chunks.docs/eulix-cli/query/retrieval/Search-Pipeline.md
- Retrieval Selection And HydrationThis page covers the second half of retrieval: widening the candidates with the call graph, choosing the final chunks, and turning signatures into real…docs/eulix-cli/query/retrieval/Selection-And-Hydration.md
- MCP Server And ToolsThis page describes the server object, the tools and prompts it exposes, and how it manages repositories and memory.docs/eulix-cli/mcp/Server-And-Tools.md
- stripThe strip package removes comments and docstrings from source code before it is shown to the model, without disturbing line numbers.docs/eulix-cli/query/Strip.md
- utilsThe utils package holds the constants, shared types, logging and small helpers that several other packages need.docs/eulix-cli/Utils.md
- Known Windows-only issuesThese issues only happen on Windows. None of them is fixed yet. Each one has a test that checks for the correct behavior, so the test fails until the…docs/eulix-cli/windows-issues.md
libeulix8stablev0.9.0
- libeulixlibeulix is the Rust library that turns source code into a structured, queryable description of a whole repository.docs/libeulix/Overview.md
- Analysis PassesThis page explains the analyze module of libeulix: the passes that turn parsed files into entry points, dependencies, patterns, indices, metrics and…docs/libeulix/Analysis-Passes.md
- Call-Graph AccuracyHow often the call graph that libeulix builds is right, measured against each language's own compiler or type checker on one real project per language.docs/libeulix/Call-Graph-Accuracy.md
- Knowledge Base SchemaThis page describes the data that libeulix produces: what each type holds, how the types nest, and which fields you can rely on.docs/libeulix/Knowledge-Base-Schema.md
- PRISM v1PRISM v1 is the fast, name-based call-graph builder in libeulix: every call resolves to the first function or method with the same name.docs/libeulix/PRISM-V1.md
- 3 MethodologyThe formal definition of PRISM v2, the scope-aware call-graph resolver in libeulix: inputs, indices, the resolution procedure, its properties and cost.docs/libeulix/Research/PRISM-V2-Methodology.md
- PRISM v2PRISM v2 is the scope-aware call-graph builder in libeulix: it resolves each call by searching from the nearest scope outward, and it declines to guess…docs/libeulix/PRISM-V2.md
- libeulix Public APIThis page lists the functions and types that libeulix exposes, shows how they fit together, and gives runnable examples.docs/libeulix/Public-API.md
eulix-parser4stablev0.9.0
- eulix-parsereulix-parser is the command-line tool that parses a whole repository with libeulix and writes the results as a set of JSON files.docs/eulix-parser/Overview.md
- Output FilesThis page describes every file that eulix_parser writes, what it contains, and which tools read it.docs/eulix-parser/Output-Files.md
- Parsing PipelineThis page walks through what eulix-parser does during a run, phase by phase, and explains the reasoning behind the choices that are not obvious from the…docs/eulix-parser/Parsing-Pipeline.md
- Performance NotesThis page collects the measured performance of eulix_parser and the lessons recorded while tuning it.docs/eulix-parser/Performance-Notes.md
eulix-embed6stablev0.4.2
- eulix-embedeulix-embed is the Python tool that turns the parser's knowledge base into vectors, and answers "what vector is this question?" while you chat.docs/eulix-embed/Overview.md
- Binary FormatThis page specifies embeddings.bin and vectors.bin, the two files eulix-embed writes and eulix reads.docs/eulix-embed/Binary-Format.md
- ChunkingThis page explains how kb.json is cut into the text pieces that get embedded, and what those pieces actually contain today.docs/eulix-embed/Chunking.md
- EmbeddersThis page describes the two model backends, ONNX Runtime and PyTorch, how each picks a device, and what turns model output into a vector.docs/eulix-embed/Embedders.md
- Embedding PipelineThis page walks through what embed does from the knowledge base to the two output files, and why it is built the way it is.docs/eulix-embed/Pipeline.md
- ServerThis page documents the server command: a long-running process that keeps a model loaded and embeds questions on request.docs/eulix-embed/Server.md
vizEulize3stable
- vizEulizevizEulize is a browser-based explorer for the call graph that eulix_parser produces. It turns kb_call_graph.json into an interactive, searchable graph…docs/vizEulize/Overview.md
- vizEulize InternalsThis page explains how vizeulize.html works inside, for anyone who needs to fix a bug or add a feature.docs/vizEulize/Internals.md
- Using the ExplorerThis page is a guide to using vizEulize once it is open: how to find things, how to read what you see, and which keys and mouse actions to use.docs/vizEulize/Using-The-Explorer.md
Architecture6
- Version BenchmarkThis page explains the benchmark that compares two eulix versions: what it measures, why it is built the way it is, how to run it, and where it keeps its…docs/Architecture/Benchmarking.md
- Call-Graph Benchmark ScoringThis page explains, step by step, how the call-graph accuracy harness in bench/callgraph/ turns two lists of calls into precision, recall and the other…docs/Architecture/Call-Graph-Scoring.md
- Incremental ParsingThis page explains how eulix-parser avoids re-parsing files that have not changed since the previous run, and how it keeps that shortcut safe.docs/Architecture/Incremental-Parsing.md
- LSP BenchmarkThis page explains the benchmark for eulix-lsp: what it measures, how to run it, how to read its output, and the results it gave for commit bb695d1 and…docs/Architecture/LSP-Benchmarking.md
- LSP IndexingThis page explains how eulix-lsp builds its workspace index: how it scans files, parses them, and commits them into the index that cross-file features…docs/Architecture/LSP-Indexing.md
- Spill to DiskThis page explains how eulix-parser keeps memory under control on very large repositories by writing each file's output to disk as soon as the file is…docs/Architecture/Spill-To-Disk.md
Known issues7
- Known IssuesThis section lists the bugs and limitations that Eulix has today, how serious they are, how we know about them, and what to do in the meantime.docs/Known-Issues/Overview.md
- CLI, MCP And TUI IssuesKnown problems in the eulix command line, the terminal screens, the MCP server and the model client.docs/Known-Issues/CLI-MCP-And-TUI.md
- Embedding IssuesKnown problems in the embedding tool (eulix-embed) and the query-time embedder in eulix-cli.docs/Known-Issues/Embeddings.md
- Fixed IssuesProblems that used to exist and no longer do, with the test that now guards each one. This is the record behind the open lists, so that a regression can…docs/Known-Issues/Fixed-Issues.md
- LSP IssuesKnown problems in the eulix-lsp language server: wrong edits or locations, slow paths, and memory use.docs/Known-Issues/LSP.md
- Parser And PRISM IssuesKnown problems in libeulix and eulix-parser: how files are parsed, and how PRISM links calls to definitions.docs/Known-Issues/Parser-And-PRISM.md
- Retrieval And Query IssuesKnown problems in how Eulix chooses the context it shows the model.docs/Known-Issues/Retrieval-And-Query.md