Skip to main content

A vector-powered CLI for semantic search over filenames.

Project description

Vexor

Vexor

Python PyPI CI Codecov License


Vexor is a vector-powered CLI that searches file names semantically. It uses Google GenAI's gemini-embedding-001 model to embed file names and queries, then ranks 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.

Workflow

  1. Index the project root (includes every subdirectory):
    vexor index --path ~/projects/demo --include-hidden
    
  2. Search from anywhere, pointing to the same path:
    vexor search "api client config" --path ~/projects/demo --top 5
    
    Output example:
    Vexor semantic file search results
    ──────────────────────────────────
    1   0.923   ./src/config_loader.py
    2   0.871   ./src/utils/config_parse.py
    3   0.809   ./tests/test_config_loader.py
    

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.

Commands

Command Description
vexor index --path PATH [--include-hidden] [--no-recursive] [--clear] Scans PATH (recursively by default), embeds file names, and writes a cache under ~/.vexor.
vexor search QUERY --path PATH [--top K] [--include-hidden] [--no-recursive] Loads the cached embeddings for PATH (matching the chosen recursion and hidden settings) and ranks 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.

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.3.0.tar.gz (17.3 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.3.0-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vexor-0.3.0.tar.gz
Algorithm Hash digest
SHA256 401669b1986a11d7babd63d2ac38d16161fc593aaabb1fd2ba49b5865ba15bec
MD5 8116334ce1048208761d8384ba466577
BLAKE2b-256 054ccec64b1dc9b96fd416bd9e99b265b892f307546eb4eade9ee658593b40fc

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: vexor-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 22.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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d22e07238e42ab884fd648e6c517fa2c0110129319f359df8d8a62d7fe0ffd02
MD5 4b51436e6bcc0afed98347ec96a4121d
BLAKE2b-256 ecd43525470a1ec0854c67dfc5fbd3b1a1ced6ef8663753dc449eb29377a74fa

See more details on using hashes here.

Provenance

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