Sweep CLI Installation

Prerequisites: python 3.10 and pip

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). To self-host your own deployment of Sweep, visit deployment (15 min).

Install the Sweep CLI

terminal

pip install sweepai

Initialize the Sweep CLI

Initialize the CLI with your GitHub and OpenAI API keys:

terminal

sweep init

and follow the prompts to enter your GitHub and OpenAI 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, see self-hosting Sweep's GitHub App and book a call (opens in a new tab) with us for a commercial license.

🚀 Getting Started 🏠 Self-Host