A vector-powered CLI for semantic search over files.
Project description
Vexor is a vector-powered CLI for semantic file search. It uses configurable embedding models and ranks results by cosine similarity.
Why Vexor?
When you remember what a file does but forget its name or location, Vexor finds it instantly—no grep patterns or directory traversal needed.
Designed for both humans and AI coding assistants, enabling semantic file discovery in autonomous agent workflows.
Install
Download standalone binary from releases (no Python required), or:
pip install vexor # also works with pipx, uv
Quick Start
1. Configure API Key
vexor config --set-api-key "YOUR_KEY"
Or via environment: VEXOR_API_KEY, OPENAI_API_KEY, or GOOGLE_GENAI_API_KEY.
2. Search
vexor search "api client config" # searches current directory
# or explicit path:
vexor search "api client config" --path ~/projects/demo --top 5
Vexor auto-indexes on first search. Example output:
Vexor semantic file search results
──────────────────────────────────
# Similarity File path Lines Preview
1 0.923 ./src/config_loader.py - config loader entrypoint
2 0.871 ./src/utils/config_parse.py - parse config helpers
3 0.809 ./tests/test_config_loader.py - tests for config loader
3. Explicit Index (Optional)
vexor index # indexes current directory
# or explicit path:
vexor index --path ~/projects/demo --mode code
Useful for CI warmup or when auto_index is disabled.
Configuration
vexor config --set-provider openai # default; also supports gemini
vexor config --set-model text-embedding-3-small
vexor config --set-batch-size 0 # 0 = single request
vexor config --set-auto-index true # auto-index before search (default)
vexor config --set-base-url https://proxy.example.com # optional proxy
vexor config --clear-base-url # reset to official endpoint
vexor config --show # view current settings
Config stored in ~/.vexor/config.json.
Index Modes
Control embedding granularity with --mode:
| Mode | Description |
|---|---|
auto |
Default. Smart routing: Python → code, Markdown → outline, small files → full, large files → head |
name |
Embed filename only (fastest, zero content reads) |
head |
Extract first snippet for lightweight semantic context |
brief |
Extract high-frequency keywords from PRDs/requirements docs |
full |
Chunk entire content; long documents searchable end-to-end |
code |
AST-aware chunking by Python module/class/function boundaries; non-.py falls back to full |
outline |
Chunk Markdown by heading hierarchy with breadcrumbs; non-.md falls back to full |
Cache Behavior
Index cache keys derive from: --path, --mode, --include-hidden, --no-recursive, --no-respect-gitignore, --ext.
Keep flags consistent to reuse cache; changing flags creates a separate index.
vexor config --show-index-all # list all cached indexes
vexor config --clear-index-all # clear all cached indexes
vexor index --path . --clear # clear index for specific path
Re-running vexor index only re-embeds changed files; >50% changes trigger full rebuild.
Command Reference
| Command | Description |
|---|---|
vexor search QUERY --path PATH |
Semantic search (auto-indexes if needed) |
vexor index --path PATH |
Build/refresh index manually |
vexor config --show |
Display current configuration |
vexor install --skills claude |
Install Agent Skill for Claude Code |
vexor install --skills codex |
Install Agent Skill for Codex |
vexor doctor |
Check if vexor is on PATH |
vexor update |
Check for new version |
Common Flags
| Flag | Description |
|---|---|
--path PATH |
Target directory (default: current working directory) |
--mode MODE |
Index mode (auto/name/head/brief/full/code/outline) |
--top K / -k |
Number of results (default: 5) |
--ext .py,.md / -e |
Filter by extension (repeatable) |
--include-hidden / -i |
Include hidden files |
--no-recursive / -n |
Don't recurse into subdirectories |
--no-respect-gitignore |
Include gitignored files |
--format porcelain |
Script-friendly TSV output |
--format porcelain-z |
NUL-delimited output |
Porcelain output fields: rank, similarity, path, chunk_index, start_line, end_line, preview (line fields are - when unavailable).
AI Agent Skill
This repo includes a skill for AI agents to use Vexor effectively:
vexor install --skills claude # Claude Code
vexor install --skills codex # Codex
Skill source: plugins/vexor/skills/vexor-cli
Documentation
See docs for more details.
Contributions, issues, and PRs welcome! Star ⭐ if you find it helpful.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vexor-0.10.0a1.tar.gz.
File metadata
- Download URL: vexor-0.10.0a1.tar.gz
- Upload date:
- Size: 40.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fde4f6a53d80d8fcc7e49b9e7f147d7b174855d897c085b1e1519421b384a72d
|
|
| MD5 |
d49924b20a7939de5e365e59197a6c7d
|
|
| BLAKE2b-256 |
6ff80d160dcbfa2e2034df37c610481ac03ce28ea2b293fffbe961eacda83f56
|
Provenance
The following attestation bundles were made for vexor-0.10.0a1.tar.gz:
Publisher:
publish.yml on scarletkc/vexor
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vexor-0.10.0a1.tar.gz -
Subject digest:
fde4f6a53d80d8fcc7e49b9e7f147d7b174855d897c085b1e1519421b384a72d - Sigstore transparency entry: 771101140
- Sigstore integration time:
-
Permalink:
scarletkc/vexor@351cf5305f25c7803668024b6c40dd11b85363f3 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/scarletkc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@351cf5305f25c7803668024b6c40dd11b85363f3 -
Trigger Event:
push
-
Statement type:
File details
Details for the file vexor-0.10.0a1-py3-none-any.whl.
File metadata
- Download URL: vexor-0.10.0a1-py3-none-any.whl
- Upload date:
- Size: 48.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d14df2a0fe94d70f61552141ff0e3c8cab8fdc9a22b4d1bf2835ee44e79ea45c
|
|
| MD5 |
9065f7ddebdd7aa5704b6cb85ac285ae
|
|
| BLAKE2b-256 |
02af68400064ee71cd4a24394925f5973993e030ced1469ae8da605819fda4af
|
Provenance
The following attestation bundles were made for vexor-0.10.0a1-py3-none-any.whl:
Publisher:
publish.yml on scarletkc/vexor
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vexor-0.10.0a1-py3-none-any.whl -
Subject digest:
d14df2a0fe94d70f61552141ff0e3c8cab8fdc9a22b4d1bf2835ee44e79ea45c - Sigstore transparency entry: 771101144
- Sigstore integration time:
-
Permalink:
scarletkc/vexor@351cf5305f25c7803668024b6c40dd11b85363f3 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/scarletkc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@351cf5305f25c7803668024b6c40dd11b85363f3 -
Trigger Event:
push
-
Statement type: