S
Semantiq
Documentation

Quick Start

Get Semantiq up and running in your project in under 5 minutes.

Installation

Install Semantiq using npm (recommended):

npm install -g semantiq-mcp

Or install from source using Cargo:

cargo install --git https://github.com/so-keyldzn/semantiq.git

Indexing Your Codebase

Navigate to your project directory and run the index command:

# Index the current directory
semantiq index .

# Index a specific directory
semantiq index /path/to/project

# Index with verbose output
semantiq index . --verbose

Semantiq will create a .semantiq.db file in your project root. This file contains the semantic index of your codebase.

Searching Your Code

Use the search command to find code semantically:

# Search for a pattern
semantiq search "authentication handler"

# Search for a specific function
semantiq search "handleLogin"

# Search with limit
semantiq search "database" --limit 10

MCP Server Mode

Start Semantiq as an MCP server to integrate with AI assistants like Claude Code:

semantiq serve

See the MCP Integration guide for detailed configuration instructions.

Configuration

Semantiq can be configured using a .semantiq.toml file in your project root:

.semantiq.tomltoml
# .semantiq.toml
[index]
# Patterns to exclude from indexing
exclude = [
  "node_modules",
  "target",
  ".git",
  "dist",
  "build"
]

# Maximum file size to index (in bytes)
max_file_size = 1048576  # 1MB

[languages]
# Enable/disable specific languages
rust = true
typescript = true
javascript = true
python = true
go = true
java = true
c = true
cpp = true
php = true

Next Steps