# Optiq Code

> A context engine for software repositories. Optiq indexes your codebase, resolves symbol relationships, and delivers ranked search results that AI coding agents can trust.

## What Optiq Does

Optiq Code is a deterministic context retrieval engine. It parses source code into ASTs, builds dependency graphs, and creates hybrid search indexes (semantic + keyword). When an AI agent needs to find relevant code, Optiq returns ranked results with function signatures, call graphs, and confidence scores — in ~1-2 seconds.

## Key Features

- **Hybrid Search**: Semantic vector search + keyword matching in a single query
- **AST Parsing**: Full abstract syntax tree analysis for 12 languages (Python, TypeScript, JavaScript, TSX, Rust, Go, Java, C, C++, Ruby, PHP, C#)
- **Symbol Resolution**: Tracks imports, exports, function calls, and references across files
- **Confidence Scoring**: Every result includes a relevance score so agents can filter by quality
- **MCP Server**: Built-in Model Context Protocol server for direct agent integration
- **CLI Tool**: `npm install -g @optiqcode/cli` — index, search, and serve from the terminal

## When to Use Optiq

Use Optiq when your AI coding agent needs to:
- Find the right function in a large codebase without scanning every file
- Understand how code connects across modules (who calls what, who imports what)
- Get precise context windows instead of dumping entire files into the prompt
- Reduce hallucination by providing verified, ranked code context

## Links

- [Documentation](https://optiqcode.com/docs)
- [Developer Portal](https://optiqcode.com/developers)
- [Pricing](https://optiqcode.com/pricing)
- [Blog](https://optiqcode.com/blog)
- [Security](https://optiqcode.com/security)
- [Status](https://optiqcode.com/status)
- [NPM Package](https://www.npmjs.com/package/@optiqcode/cli)
- [GitHub](https://github.com/optiqcode)
- [Contact](https://optiqcode.com/contact)

## Machine-Readable Discovery

- [OpenAPI Spec](https://optiqcode.com/openapi.json) — Full API specification (OpenAPI 3.1)
- [MCP Server](https://optiqcode.com/.well-known/mcp) — Model Context Protocol discovery
- [Agent Card](https://optiqcode.com/.well-known/agent-card.json) — Agent capabilities and auth
- [AI Plugin](https://optiqcode.com/.well-known/ai-plugin.json) — OpenAI plugin manifest
- [OAuth Metadata](https://optiqcode.com/.well-known/oauth-authorization-server) — Authorization server metadata
- [Pricing (markdown)](https://optiqcode.com/pricing.md) — Machine-readable pricing
- [Agent Mode](https://optiqcode.com/?mode=agent) — Structured JSON view for agents

## Pricing

- **Free**: 3 repos, 50k lines, 100 queries/day
- **Pro (Free during beta)**: Unlimited repos, unlimited queries, bring your own Voyage + Groq API keys
- **Enterprise**: Custom deployment, SSO/SAML, audit logging, dedicated support

## API

Base URL: `https://api.optiqcode.com`

### Search
```
POST /api/v1/search
Authorization: Bearer <api_key>
Content-Type: application/json

{
  "query": "authentication middleware",
  "repo_id": "my-project",
  "limit": 10
}
```

### Index
```
POST /api/v1/repos
Authorization: Bearer <api_key>
Content-Type: application/json

{
  "repo_url": "https://github.com/user/repo"
}
```

## Installation

```bash
npm install -g @optiqcode/cli
optiq login
optiq index .
optiq search "your query"
```