CSEP(1)

NAME
csep - Cosine Similarity Embeddings Print

SYNOPSIS
csep [OPTIONS] [QUERY] [COMPARISON]

DESCRIPTION
csep is a tool used to compute and print the Cosine Similarity between text embeddings. By default it prints rg-style output (path:line:match) with color, and --vimgrep can be used for vim quickfix-compatible output.

ARGUMENTS

QUERY
    User search query.

COMPARISON
    If provided, compares the QUERY to this string and returns the cosine similarity score.

OPTIONS

-f, --floor FLOOR
    Similarity floor. Any result below this floating-point value will be filtered out from the results.

-n, --no-query
    If set, the query will not be printed out with the results.

-l, --list-models
    List the available embedding models.

-v, --vimgrep
    Print in vimgrep compatible mode.

-g, --glob GLOB
    Include or exclude files using glob patterns (repeatable).

-M, --model MODEL
    Set the model.

-c, --client CLIENT
    Set whether to use the ollama or fastembed client.

-h, --help
    Prints help information and exits.

-V, --version
    Prints version information and exits.

AUTHOR
Written by Divan Visagie (me@divanv.com).

EXAMPLES

Compare two strings for similarity:
    csep first string second string

Use a similarity floor of 0.5:
    csep -f 0.5 first string second string

List the available embedding models:
    csep --list-models

Print in vimgrep compatible mode:
    csep --vimgrep

Set the model to "model_name":
    csep --model model_name

Set the client to "ollama":
    csep --client ollama

Do not print the query with the results:
    csep -n first string second string

SEE ALSO
For more information, visit the official repository or contact the author.

COPYRIGHT
Written by Divan Visagie, 2024.