πŸ”§ Sweep CLI

Sweep CLI Installation

Prerequisites: python 3.10 and pip. We also recommend uv (opens in a new tab) for a ~1s install.

Sweep CLI is a locally running version of Sweep (no data will enter our servers).

To use our hosted version of Sweep, install it here (2 min) (opens in a new tab).

Install the Sweep CLI

terminal
pip install sweepai

Initialize the Sweep CLI

Initialize the CLI with your OpenAI, Anthropic and GitHub API keys:

terminal
sweep init

and follow the prompts to enter your API keys.

Run the Sweep CLI

Create a GitHub Issue like the examples in our guide in your repo, and run the following command:

terminal
sweep run https://github.com/YOUR-USERNAME/YOUR-REPO/issues/1

To have Sweep automatically fix newly created issues, you can also run the following command:

terminal
sweep watch YOUR-USERNAME/YOUR-REPO

πŸŽ‰ Congratulations!

You have successfully set up the Sweep CLI. You can now use Sweep to help handle GitHub issues and pull requests.
To set up Sweep for your organization, book a call (opens in a new tab) with us for a commercial license.


Bonus (optional)

Ripgrep

Our search pipeline involves agentic search which sometimes uses Ripgrep, which you can install by running:

terminal
brew install ripgrep

For other methods of installation, you can visit here (opens in a new tab)

Eslint

If you're editing Javascript / Typescript code, our code editing agent will use your global copy of eslint. You need npm and npx installed, and you can install all the required packages with

terminal
npm i -g typescript eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import

You can double check it's working with:

terminal
npx eslint --version

Search Improvements using Other Search Providers

Cohere Rerank v3

Cohere's Rerank v3 endpoint can improve search's recall by > 5%. You can get an API key from https://dashboard.cohere.com/api-keys (opens in a new tab) and run:

terminal
export COHERE_API_KEY=abcdefg

Then Sweep will use Cohere to rerank the top 100 snippets after the initial retrieval.

Voyage AI

Voyage AI's voyage-code-2 embedding model achieves a 3% higher search recall compared to OpenAI's Ada v3. You can get an API key from https://dash.voyageai.com/api-keys (opens in a new tab) and run:

terminal
export VOYAGE_API_KEY=pa-abcdefg

Then Sweep will use Voyage AI for retrieval instead of OpenAI.

Self-hosted Search Providers

For connecting with self-hosted Cohere's or Voyage AI's model(s) on AWS SageMaker, contact us at team@sweep.dev.