1. To index the codebase locally, we use the open-source project Marqo, which is both an embedder and a vector store. To bring up a Marqo instance:

   docker rm -f marqo
   docker pull marqoai/marqo:latest
   docker run --name marqo -it -p 8882:8882 marqoai/marqo:latest
   

   This will open a persistent Marqo console window. This should take around 2-3 minutes on a fresh install.

2. To chat with an LLM locally, we use Ollama:

   • Head over to ollama.com to download the appropriate binary for your machine.
   • Open a new terminal window
   • Pull the desired model, e.g. ollama pull llama3.1.

1. We support OpenAI for embeddings (they have a super fast batch embedding API) and Pinecone for the vector store. So you will need two API keys:

   export OPENAI_API_KEY=...
   export PINECONE_API_KEY=...
   

2. Create a Pinecone index on their website and export the name:

   export PINECONE_INDEX_NAME=...
   

3. For chatting with an LLM, we support OpenAI and Anthropic. For the latter, set an additional API key:

   export ANTHROPIC_API_KEY=...
   

1. Select your desired repository:

   export GITHUB_REPO=huggingface/transformers
   

2. Index the repository. This might take a few minutes, depending on its size.

   r2v-index $GITHUB_REPO
   

3. Chat with the repository, once it's indexed:

   r2v-chat $GITHUB_REPO
   

   To get a public URL for your chat app, set --share=true.

1. Select your desired repository:

   export GITHUB_REPO=huggingface/transformers
   

2. Index the repository. This might take a few minutes, depending on its size.

   r2v-index $GITHUB_REPO \
       --embedder-type=openai \
       --vector-store=pinecone \
       --index-name=$PINECONE_INDEX_NAME
   

3. Chat with the repository, once it's indexed:

   r2v-chat $GITHUB_REPO \
       --vector-store-type=pinecone \
       --index-name=$PINECONE_INDEX_NAME \
       --llm-provider=openai \
       --llm-model=gpt-4
   

   To get a public URL for your chat app, set --share=true.

You can specify an inclusion or exclusion file in the following format:

# This is a comment
ext:.my-ext-1
ext:.my-ext-2
ext:.my-ext-3
dir:my-dir-1
dir:my-dir-2
dir:my-dir-3
file:my-file-1.md
file:my-file-2.py
file:my-file-3.cpp

where:

• ext specifies a file extension
• dir specifies a directory. This is not a full path. For instance, if you specify dir:tests in an exclusion directory, then a file like /path/to/my/tests/file.py will be ignored.
• file specifies a file name. This is also not a full path. For instance, if you specify file:__init__.py, then a file like /path/to/my/__init__.py will be ignored.

To specify an inclusion file (i.e. only index the specified files):

r2v-index $GITHUB_REPO --include=/path/to/inclusion/file

To specify an exclusion file (i.e. index all files, except for the ones specified):

r2v-index $GITHUB_REPO --exclude=/path/to/exclusion/file

By default, we use the exclusion file sample-exclude.txt.

To index GitHub issues without comments:

r2v-index $GITHUB_REPO --index-issues

To index GitHub issues with comments:

r2v-index $GITHUB_REPO --index-issues --index-issue-comments

To index GitHub issues, but not the codebase:

r2v-index $GITHUB_REPO --index-issues --no-index-repo