Sandbox Config Tool v0

[kevinlu1248]

This CLI tool tests your sweep.yaml configuration, to make the sandbox configurations easier to set up.

Getting Started

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 Trunk-based config

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

We recommend starting with the formatters

Testing

You can test the install and check flows of your sweep.yaml by executing the sweep-sandbox binary from 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 repo and sweep-sandbox sweepai/api.py.

---

This discussion was created from the release Sandbox Config Tool v0.

[Sintayew4]

#1514

[Allwyu]

Yoo

[kevinlu1248]

Thanks, @Sintayew4! This tool is now deprecated and the new CLI can be found at #1514.