Sandbox Config Tool v1

sweep-sandbox is a CLI tool that tests your sweep.yaml configuration, making the sandbox config setup process easier.

Sweep Sandbox is our execution environment that checks against static code analysis tools like formatters, linters, type-checkers and tests after every file edit, ensuring pristine generated code.

Getting Started

Start by running the following installation script in the background while setting up the rest of the sandbox configs. This should take a couple minutes.

curl https://raw.githubusercontent.com/sweepai/sweep/main/bin/install_sweep_sandbox.sh | sh

Config setup

To get started, go to your local clone of your repo. Then, create your sweep.yaml if it doesn't already exist with touch sweep.yaml then set up the sandbox section of your sweep.yaml.

For example, for Sweep, which is Python-based, we have the following sandbox config:

sandbox:
  install:
    - apt install python3.11 -y
    - pip install poetry
    - poetry env use python3.11
    - poetry install
  check: 
    - poetry run pylint --errors-only {file_path}

And for our landing page, which is Typescript-based, we have the following config

sandbox:
  install:
    - yarn install --ignore-engines
  check:
    - yarn run prettier --write {file_path}
    - yarn run eslint {file_path}
    - yarn run tsc

By default, we use the following config that runs Trunk, an opinionated super-linter that installs all the common formatters and linters for your codebase. You can set up and configure Trunk for yourself by following https://docs.trunk.io/get-started.

sandbox:
  install:
    - trunk init
  check:
    - trunk fmt {file_path}
    - trunk check {file_path}

We recommend starting with the formatters, followed by the linters and type-checkers.

Testing

Ensure that sweep-sandbox is installed properly by running it. Then execute the following in the base of your repo in the following format:

sweep-sandbox {file_path}

For example in the Sweep repo, we run sweep-sandbox sweepai to test it on the entire sweepai directory and sweep-sandbox sweepai/api.py to check the single file api.py.

Sweep Extension v0.0.1

This is a patch to make the installation easier for the Sweep Browser Extension, a tool to make creating Sweep issues easier.

You can now create an issue directly from the home page of the repo. Once you fill out the form Sweep will submit the issue for you.

We also want to make the issue creation flow through this tool easier such as auto-completing file names and docs drag-and-drop. Currently, only Chrome is supported. Stay tuned for when more features get released at https://discord.gg/sweep.

Installation

1. Download sweep_extension.crx
2. Go to chrome://extensions/ and turn on developer mode in the top-right corner
3. Drag the downloaded file into the page.

You'll get automatically sent to the post-installation and usage instructions.

Sweep Browser Extension v0

Update: check out https://github.com/sweepai/sweep/releases/tag/browser-extension-v0.0.1 instead

This is the initial build of the Sweep Browser Extension, a tool to make creating Sweep issues easier.

You can now create an issue directly from the home page of the repo. Once you fill out the form Sweep will submit the issue for you.

We also want to make the issue creation flow through this tool easier such as auto-completing file names and docs drag-and-drop. Currently, only Chrome is supported. Stay tuned for when more features get released at https://discord.gg/sweep.

Installation

Unfortunately, the Chrome Webstore takes weeks to approve this extension so this is the only installation method for now.

1. Download and unzip sweep.zip
2. Go to chrome://extensions/
3. Click load unpacked and select the newly unzipped directory

Getting started

Check out the post-installation instructions.

Sweep v1.0.0: Initial release

Sweep is an AI junior developer that transforms bug reports & feature requests into code changes.

Describe bugs, small features, and refactors like you would to a junior developer, and Sweep:

• 🔍 Reads your codebase
• 📝 Plans the changes
• ⚡Writes a pull request with code⚡

Features

• 🌠 Turns issues directly into pull requests (without an IDE)
• 👀 Addresses developer replies & comments on its PRs
• 🔎 Uses embedding-based code search & external docs
• ☑️ Validates its changes with GitHub Actions and self-review
• ⚙️ Configurable - tell Sweep about your own repository and add custom external documentation