1.0.1 • Published 7 months ago

@pr4j3sh/oscar v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

oscar

open source codebase augmented retrieval

oscar is a CLI tool that lets you semantically search and query any open source codebase. It uses embeddings and retrieval to help you understand large projects faster.

Installation

  • Install oscar using npm
npm i -g @pr4j3sh/oscar
  • Install chromadb

    • using pipx
    pipx install chromadb
    • Or, using docker
    docker run -v ./chroma-data:/data -p 8000:8000 chromadb/chroma
  • Install llama3.2

    • on linux
    curl -fsSL https://ollama.com/install.sh | sh
    • for windows, macos, visit here.

Usage

  • run llama3.2
ollama run llama3.2
  • run chromadb
chroma run
  • create collection
oscar [init | i] -c <collection_name> <path_to_codebase>

this is a one-time process

  • query collection
oscar [query | q] -c <collection_name> "<query>"
  • list collections
oscar [list]
  • delete collection
oscar [rm] <collection_name>

Reference