# OX

> OX is a methodology — and two parallel implementations — for developers who think and build in the same place. It co-locates **knowledge** (an Obsidian vault) and **code** (your git repos) in one directory tree, then indexes both into a single searchable knowledge graph that humans and AI agents navigate the same way.

Two trees, one workspace: `o/` is for thinking (knowledge, decisions, people, history), `x/` is for doing (code, infrastructure, deployments). The power is the bridge between them — a `CLAUDE.md` in `x/` cross-references notes in `o/`, and a project doc in `o/` points to its repo in `x/`. The workspace *is* the context, and agents are first-class citizens who receive the same context humans get.

**⚠️ Work in progress.** OX is an early, opinionated tool developed in the open — not a polished product. It began as one developer's personal workflow, and adopting it currently means adopting that workflow. Notably, keeping the search index current is **manual**: if you don't re-run `ox index` after changing notes, you get stale/degraded results. Don't use OX unless you're comfortable running and updating it yourself. See [Status & Known Issues](https://iamox.ai/docs/known-issues.md).

This site is intentionally bot-friendly. The pages below are Markdown, meant to be read by LLMs and crawlers as well as people.

## Documentation

- [Overview & Methodology](https://iamox.ai/docs/methodology.md): The "two trees, one workspace" philosophy and why co-locating knowledge and code matters.
- [Installation](https://iamox.ai/docs/installation.md): Install the `ox` binary (one curl command) and bootstrap a workspace with `ox init`.
- [CLI Reference](https://iamox.ai/docs/cli.md): Every `ox` command — init, clone, index, search, serve, status, kb, workspace, version.
- [Workspace Structure](https://iamox.ai/docs/workspace-structure.md): The full `o/` and `x/` directory tree and the who/what/when/where convention.
- [Knowledge Graph & RAG](https://iamox.ai/docs/knowledge-graph-rag.md): Hybrid BM25 + vector search, the SQLite graph, and pluggable backends.
- [Code Indexing](https://iamox.ai/docs/code-indexing.md): Indexing repos alongside notes so searches return decisions *and* implementations.
- [MCP Server](https://iamox.ai/docs/mcp-server.md): `ox serve` exposes the vault as Model Context Protocol tools for Claude Code, Cursor, and any MCP agent.
- [Two Implementations](https://iamox.ai/docs/two-implementations.md): v0.3.0 ships two parallel implementations — the Go CLI and ox-rs (Rust port). Learn which to use.
- [Status & Known Issues](https://iamox.ai/docs/known-issues.md): WIP disclaimer, the manual-indexing caveat, and the tracked list of known issues.

## Optional

- [Full documentation (single file)](https://iamox.ai/llms-full.txt): All of the above concatenated for one-shot ingestion.
- [Source on GitHub](https://github.com/icewaterlabs/ox): The `ox` CLI source, releases, and issues.
- [Install script](https://iamox.ai/install.sh): The shell installer invoked by the one-line install command.