Skip to main content

A vector-powered CLI for semantic search over files.

Project description

Vexor

Vexor

Python PyPI CI Codecov License


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/JS/TS → 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 module/class/function boundaries for Python and JavaScript/TypeScript; other files fall 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 Run diagnostic checks (command, config, cache, API key, API connectivity)
vexor update [--upgrade] [--pre] Check for new version (optionally upgrade; --pre includes pre-releases)
vexor feedback Open GitHub issue form (or use gh)

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

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vexor-0.11.0rc1.tar.gz (50.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vexor-0.11.0rc1-py3-none-any.whl (58.8 kB view details)

Uploaded Python 3

File details

Details for the file vexor-0.11.0rc1.tar.gz.

File metadata

  • Download URL: vexor-0.11.0rc1.tar.gz
  • Upload date:
  • Size: 50.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vexor-0.11.0rc1.tar.gz
Algorithm Hash digest
SHA256 5f9a3dc3cceadd1d4ce4ae7d4b4355b87dcb59058b026c6a35beacfb669e5582
MD5 33f91f8421ee50dfbd73fdc39be8130a
BLAKE2b-256 927cbb1f7fe9b15fc21e8586981b9807b98f4432c4d63e10ccf16db7e7db1698

See more details on using hashes here.

Provenance

The following attestation bundles were made for vexor-0.11.0rc1.tar.gz:

Publisher: publish.yml on scarletkc/vexor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vexor-0.11.0rc1-py3-none-any.whl.

File metadata

  • Download URL: vexor-0.11.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 58.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vexor-0.11.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 2f89370f74c735c4027996a8109df5a8baab862e66a7aad13632859f23835aa6
MD5 72809d9261f29e260feb375c87f26b71
BLAKE2b-256 afab7527ecbde5029650c59ee583f7b3be2b050e8b1d0dd01e644decca814b79

See more details on using hashes here.

Provenance

The following attestation bundles were made for vexor-0.11.0rc1-py3-none-any.whl:

Publisher: publish.yml on scarletkc/vexor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page