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.
  • Hidden files are included only if both index and search use --include-hidden.

Commands

Command Description
vexor index --path PATH [--include-hidden] [--clear] Recursively scans PATH, embeds file names, and writes a cache under ~/.vexor.
vexor search QUERY --path PATH [--top K] [--include-hidden] Loads the cached embeddings for PATH 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.2.1.tar.gz (15.1 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.2.1-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vexor-0.2.1.tar.gz
Algorithm Hash digest
SHA256 2e8db80022de7336eaa6948aa976ad163bfb28a72a74575b0520387fe40c294d
MD5 f8373eeb74fa9817a0c2e1695752ec81
BLAKE2b-256 9d11b0d4025b4b201d804750d6b816354ce92972bf05804605fbaf69b901db12

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: vexor-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 20.6 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fdd154854fb109a00c28089be0cf248c183b06a934f737a5a7c884c8954e25c1
MD5 1a5cc6b2fc1549797a6400a7d207164e
BLAKE2b-256 93faf6d84bc42d90bbf7c43fd06c8b409287dfa86bc89ca21a50a44f6b29a514

See more details on using hashes here.

Provenance

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