Getting Started

Requirements

• Node.js >= 20
• pnpm or npm
• Embedding and rerank API configuration

Installation

npm install -g @chiway/contextweaver

You can also install it with pnpm:

pnpm add -g @chiway/contextweaver

Initialize configuration

contextweaver init

Short alias:

cw init

The command creates ~/.contextweaver/.env. Edit it and configure your embedding and rerank providers:

EMBEDDINGS_API_KEY=your-api-key-here
EMBEDDINGS_BASE_URL=https://api.siliconflow.cn/v1/embeddings
EMBEDDINGS_MODEL=BAAI/bge-m3
EMBEDDINGS_DIMENSIONS=1024

RERANK_API_KEY=your-api-key-here
RERANK_BASE_URL=https://api.siliconflow.cn/v1/rerank
RERANK_MODEL=BAAI/bge-reranker-v2-m3

Index a codebase

Run this from the target repository root:

contextweaver index

Index a specific path:

contextweaver index /path/to/your/project

Force a full re-index:

contextweaver index --force

Search code

cw search --information-request "How is user authentication implemented?"

Use exact technical terms when needed:

cw search \
  --information-request "Database connection logic" \
  --technical-terms "DatabasePool,Connection"

Next steps

To let an AI client retrieve context from your codebase directly, see MCP Integration, which includes setup examples for Codex and Claude Code.