Optiq CLI

Official CLI tool for Optiq - automatic code indexing and intelligent context engine for your codebase.

Installation

npm install -g @optiqcode/cli

Quick Start

1. Login to Optiq

optiq login

2. Index your codebase

optiq index
# Or specify a directory
optiq index --path ./my-project

3. Watch for changes (optional)

optiq watch
# Or specify a directory
optiq watch --path ./my-project

Commands

optiq login

Authenticate with your Optiq account. You'll need to provide your email and password.

optiq logout

Sign out from your Optiq account.

optiq whoami

Display your current logged-in account.

optiq index [options]

Index your codebase for intelligent search and context retrieval.

Options:

• --path <directory> - Directory to index (defaults to current directory)

Features:

• Incremental indexing (only re-indexes changed files)
• Respects .gitignore patterns
• Supports multiple languages (TypeScript, JavaScript, Python, Rust, Go, Java, C/C++, and more)

optiq watch [options]

Watch your codebase for changes and automatically re-index modified files.

Options:

• --path <directory> - Directory to watch (defaults to current directory)

Features:

• Real-time file monitoring
• Debounced indexing (waits 5 seconds after last change)
• Automatic incremental updates

Use Cases

• AI-Powered Code Search: Use with the Optiq MCP server for intelligent codebase queries
• Context Engine: Provide relevant code context to AI assistants
• Documentation: Keep your code index up-to-date for documentation tools
• Code Analysis: Enable advanced code analysis and insights

Configuration

The CLI stores your authentication token in ~/.optiq/config.json.

Requirements

• Node.js >= 18.0.0
• An Optiq account (sign up at optiqcode.com)

Support

• Documentation: docs.optiqcode.com
• Issues: github.com/optiqcode/optiq/issues
• Email: [email protected]

License

MIT