Skip to content

armgit / Ix

Public Imported from GitHub
0

Understand any codebase instantly. System intelligence for codebases, built for humans and AI.

2.5 KB
Raw Blame
---
title: Ix documentation
description: Install Ix, query your codebase's graph from the CLI or your AI agent, and look up every command, flag and endpoint.
---

import { CardGrid, LinkCard } from '@astrojs/starlight/components'

Ix maps a repository into a graph of its symbols, calls and imports, stored on your machine. You query the
graph from the `ix` CLI, from AI agents over MCP, and in the Compass visualizer. These docs cover installing
Ix, using it day to day, connecting your agents, and the full reference for every command, flag and endpoint.

## Install

```bash
curl -fsSL https://ix-infra.com/install.sh | sh    # macOS / Linux
```

On Windows, or to see what the installer sets up, read [Installation](/getting-started/installation/).

## Start here

<CardGrid>
  <LinkCard title="Quickstart" description="Map a repository and run your first queries." href="getting-started/quickstart/" />
  <LinkCard title="What is Ix?" description="What the graph holds and what it answers." href="getting-started/introduction/" />
  <LinkCard title="Connect your AI agent" description="Register Ix's MCP server with your clients." href="integrations/overview/" />
  <LinkCard title="Command reference" description="Every command, by the question it answers." href="reference/commands/" />
</CardGrid>

## Browse the docs

**Concepts**
- [How Ix works](/concepts/how-it-works/): the parser, the local backend and the three clients.
- [Output formats](/concepts/output-formats/): `text`, `json` and `llm`, and setting a default.

**Guides**
- [Everyday workflows](/guides/everyday-workflows/): recipes for the questions developers ask most.
- [Visualize with Compass](/guides/compass/): explore the graph in your browser.
- [Troubleshooting](/guides/troubleshooting/): fixes for the most common problems.

**AI agents**
- [MCP server](/integrations/mcp/): the tools `ix mcp` serves and how clients are registered.
- [Agent skill](/integrations/agent-skill/): teach an agent to drive the CLI.
- [Native plugins](/integrations/plugins/): Claude Code, Codex, Cursor, Gemini CLI, OpenCode and OpenClaw.

**Reference**
- [Commands](/reference/commands/), [Flags](/reference/flags/) and [Configuration](/reference/configuration/).
- [The llm output format](/reference/llm-format/) and [Supported languages](/reference/languages/).

**HTTP API**
- [Overview](/api/overview/), the [full reference](/api/reference/), and every endpoint, generated from the OpenAPI spec.

**Community**
- [Contributing](/community/contributing/), [Security](/community/security/) and [Get help](/community/support/).