EKOSdocs
Docs / Getting Started Build

Quickstart

From zero to a first successful query in about five minutes.

No Rust toolchain, no compiler — a prebuilt binary of the latest release (v1.2.0, 2026-11-04). Prefer a setup page in your browser, with the web console and a Windows installer? See Installation, which also lists what each release added.

# 1. Install (Linux, macOS)
curl -fsSL https://raw.githubusercontent.com/alexeyban/EKOS/main/install.sh | sh

# 2. Compile your project
cd /path/to/my-project
ekos init --detect                # writes an ekos.toml matching this repository
ekos build && ekos recover && ekos resolve && ekos compile && ekos commit
ekos coverage                     # confirms every input kind produced objects

# 3. Query it
ekos query find "customer"

ekos init --detect beats a bare ekos init: it detects the SQL dialect your schema is written in and excludes third-party and generated directories that would otherwise be compiled as if they were your own code. A wrong dialect makes the whole-file DDL parse fail, and an entire schema disappears behind one diagnostic.

ekos coverage is the other half of that: it reports which input kinds actually compiled into objects. A kind with files present and zero objects is a named finding, not silence.

If ekos resolve stops on identity conflicts, review them, or pass --force to continue and print them as diagnostics.

To keep the config and the compiled data out of the repository, make it a project in the EKOS home instead. Nothing is written into the source directory:

ekos project add my-project --source /path/to/my-project --detect
ekos --project my-project build && ekos --project my-project recover && ekos --project my-project resolve \
  && ekos --project my-project compile && ekos --project my-project commit
ekos --project my-project query find "customer"

Connect Claude Code

claude mcp add ekos -- ekos --config /path/to/my-project/ekos.toml mcp serve --workspace /path/to/my-project
# or, for a project in the EKOS home:
claude mcp add ekos -- ekos --project my-project mcp serve

Then ask:

Claude Code asks a question; EKOS answers from the knowledge index with evidence
Claude Code asks a question; EKOS answers from the knowledge index with evidence

Claude Code will call tools such as ekos_search, ekos_query and ekos_state and cite the evidence it gets back.

Where to go from here

I want to… Read
understand what just happened How EKOS Works
ask better questions Querying Knowledge
use a non-Claude agent Connecting Other MCP Agents