diff --git a/devbox.md b/devbox.md index 48f6c120c4a..60ba8965112 100644 --- a/devbox.md +++ b/devbox.md @@ -3,23 +3,42 @@ Instant, easy, and predictable development environments -## Scripts +## Getting Started +This project uses [devbox](https://github.com/jetpack-io/devbox) to manage its development environment. + +Install devbox: +```sh +curl -fsSL https://get.jetpack.io/devbox | bash +``` -* [build](#build) -* [build-all](#build-all) -* [build-darwin-amd64](#build-darwin-amd64) -* [build-darwin-arm64](#build-darwin-arm64) -* [build-linux-amd64](#build-linux-amd64) -* [build-linux-arm64](#build-linux-arm64) -* [code](#code) -* [fmt](#fmt) -* [lint](#lint) -* [test](#test) -* [tidy](#tidy) -* [update-examples](#update-examples) - -## Init Hook +Start the devbox shell: +```sh +devbox shell +``` +Run a script in the devbox environment: +```sh +devbox run