JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 54
  • Score
    100M100P100Q47610F
  • License MIT

CLI tool for Optiq - automatic code indexing and context engine

Package Exports

  • @optiqcode/cli
  • @optiqcode/cli/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@optiqcode/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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
  1. Index your codebase
optiq index
# Or specify a directory
optiq index --path ./my-project
  1. 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

Support

License

MIT