Skip to content

installation.md

Latest commit

 

History

History
82 lines (54 loc) · 3.58 KB

installation.md

File metadata and controls

82 lines (54 loc) · 3.58 KB

Welcome to Sweep - GitHub App installed successfully! 🎉

⚠️ Be sure to follow these instructions in your own repository.

If you prefer video, check out our demo (2 min)

Create an issue on your own repository

The issue title should start with Sweep: For issues and PRs, call Sweep using the Sweep label or by prefixing your text with Sweep:

  • Sweep works best with real repositories and real issues.
Image description

Note: The initial startup time typically takes around 3-5 minutes depending on your codebase.

Fix Sweep's PRs

Sweep will mess up sometimes. Comment on it's PR. (ex: "use PyTorch instead of Tensorflow".)

  • You can also comment in the issue and code. See Commenting.
  • To have Sweep automatically improve it's PRs, use Github Actions. GHA Tech Blog
  • To disable Sweep on a PR/issue, remove the Sweep label.
Image description

Sweep Prompting Tricks 📝

  • Mention filenames or function names.
  • Describe the changes or fixes you want.
  • Provide any additional context that might be helpful.
  • For more guidance, visit Sweep Recipes.

Limitations of Sweep (for now) ⚠️

  • 🏗️ Large-scale refactors: >3 files or >150 lines of code changes (we're working on this!)

    • We can't do this - "Refactor entire codebase from Tensorflow to PyTorch"

  • ⏲️ Using the latest APIs that have changed past 2022

    • We can't do this - "Set up a vector store using LlamaIndex Typescript"
    • 🎩 However if you provide the relevant docs as links/text, then Sweep will read them and make the changes.

  • 🖼️ Editing images and other non-text assets

    • We can't do this - "Use the logo to create favicons for our landing page"

  • ⤵️ Accessing external APIs, including fetching API tokens

    • We can't do this - "Set up sign-in using Ethereum"

Pricing

We offer unlimited GPT3.5 tickets to every user. Every user also starts with 5 GPT4 issues a month, and you'll be able to use 2 GPT4 issues a day.

For professionals who want more tickets and priority support/feature requests, check out Sweep Pro now at $480/month. In addition, we're also offering 15 PRs for $60 as a one-time purchase for anyone interested in eventually purchasing Sweep Pro. You can avail this offer here.

Documentation 📚

Check out our docs.

Contact Us 👥

Note - you need to have Sweep installed and Issues enabled in Repo

Bug Reports

If Sweep fails to solve your issue that is within the scope of Sweep (see Limitations) and you submit a high-quality bug report at our Discord, we will reset your ticket count, giving your GPT-4 tickets back. This is only for GPT4 PRs.