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 that searches files semantically. It uses Google GenAI's gemini-embedding-001 model to embed files and queries, then shows matches with cosine similarity.

Install

Download from releases without python, or with:

pip install vexor # or use pipx, uv

The CLI entry point is vexor.

Configure

Set the Gemini API key once and reuse it everywhere:

vexor config --set-api-key "YOUR_KEY"

Optional defaults:

vexor config --set-model gemini-embedding-001
vexor config --set-batch-size 0   # 0 = single request

Configuration is stored in ~/.vexor/config.json.

Inspect or reset every cached index:

vexor config --show-index-all
vexor config --clear-index-all

Workflow

  1. Index the project root (includes every subdirectory):
    vexor index --path ~/projects/demo --mode name --include-hidden
    
  2. Search from anywhere, pointing to the same path:
    vexor search "api client config" --path ~/projects/demo --mode name --top 5
    
    Output example:
    Vexor semantic file search results
    ──────────────────────────────────
    #   Similarity   File path                      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
    

Tips:

  • Keep one index per project root; subdirectories need separate indexes only if you explicitly run vexor index on them.
  • Toggle --no-recursive (or -n) on both index and search when you only care about the current directory; recursive and non-recursive caches are stored separately.
  • Hidden files are included only if both index and search use --include-hidden.
  • Re-running vexor index only re-embeds files whose names changed (or were added/removed); if more than half the files differ, it automatically falls back to a full rebuild for consistency.
  • Specify the indexing mode with --mode; currently name (file names only) and head (first chunk of supported text/code/PDF/DOCX/etc. files) are available, each with its own cache.

Commands

Command Description
vexor index --path PATH --mode MODE [--include-hidden] [--no-recursive] [--clear/--show] Scans PATH (recursively by default), embeds content according to MODE (name or head), and writes a cache under ~/.vexor.
vexor search QUERY --path PATH --mode MODE [--top K] [--include-hidden] [--no-recursive] Loads the cached embeddings for PATH (matching the chosen mode/recursion/hidden settings), shows matches for QUERY.
vexor doctor Checks whether the vexor command is available on the current PATH.
vexor update Fetches the latest release version and shows links to update via GitHub or PyPI.
vexor config --set-api-key/--clear-api-key Manage the stored Gemini API key.
vexor config --set-model/--set-batch-size/--show Manage default model and batch size.
vexor config --show-index-all/--clear-index-all Inspect or delete every cached index regardless of path/mode.

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.4.2.tar.gz (21.9 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.4.2-py3-none-any.whl (28.1 kB view details)

Uploaded Python 3

File details

Details for the file vexor-0.4.2.tar.gz.

File metadata

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

File hashes

Hashes for vexor-0.4.2.tar.gz
Algorithm Hash digest
SHA256 c3b60e4368e4bc7346a2c0e86b474a9bb9fe303a99d71629b8879f21591a324c
MD5 f75f895bddd95f82cce412f521ef697d
BLAKE2b-256 192abe73706b036e1a5d25a9ee5d4ab599ef20fb68ba3ff590829b877d6c5898

See more details on using hashes here.

Provenance

The following attestation bundles were made for vexor-0.4.2.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.4.2-py3-none-any.whl.

File metadata

  • Download URL: vexor-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 28.1 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.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 012dd4bbfad2d4c093da105163ee764f0d4f6437910561ce08abb381154b9328
MD5 f3439c8237ee3cb00c4ed795507896df
BLAKE2b-256 958f271d39be31655a49376db3c5288095d28d0b1f4fa363a98ddfa5e4c2aeb3

See more details on using hashes here.

Provenance

The following attestation bundles were made for vexor-0.4.2-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