Installation
The IntelliRag indexer runs on your infrastructure, analyzes your codebase using tree-sitter AST parsing, and sends the extracted intelligence to the hosted API server. Choose the installation method that fits your environment.
Prerequisites
Section titled “Prerequisites”- A git repository to index
- An IntelliRag account with an API key
- Network access to
api.intellirag.io(or your self-hosted API server)
Install methods
Section titled “Install methods”Go install
Section titled “Go install”If you have Go 1.23 or later installed:
go install github.com/intellirag/intellirag.io/indexer/cmd/indexer@latestThis requires a working C compiler because the indexer uses CGO for tree-sitter grammars.
Binary releases
Section titled “Binary releases”Download a prebuilt binary from the GitHub releases page. Binaries are available for:
| OS | Architecture |
|---|---|
| Linux | amd64 |
| Linux | arm64 |
| macOS | amd64 (Intel) |
| macOS | arm64 (Apple Silicon) |
After downloading, make the binary executable and move it to a directory in your PATH:
chmod +x indexersudo mv indexer /usr/local/bin/Docker
Section titled “Docker”Pull the official container image:
docker pull ghcr.io/intellirag/indexer:latestRun the indexer against a local repository:
docker run --rm \ -v /path/to/your/repo:/repo \ ghcr.io/intellirag/indexer:latest \ index --api-url https://api.intellirag.io --api-key your-api-key --repo-path /repoVerify installation
Section titled “Verify installation”Confirm the indexer is installed correctly:
indexer versionThis prints the version, commit SHA, and build date.
CGO and tree-sitter
Section titled “CGO and tree-sitter”The indexer uses tree-sitter grammars for AST parsing, which requires CGO. The binary releases and Docker images include all compiled grammars and dependencies - no additional setup is needed.
If building from source via go install or go build, you need:
- A C compiler (
gccorclang) - Standard C library headers
On macOS, the Xcode command line tools provide these. On Linux, install build-essential (Debian/Ubuntu) or gcc (RHEL/Fedora).
Next steps
Section titled “Next steps”- Configure the indexer with your API key and repository path
- Review supported languages to see what gets extracted from your codebase