@@ -12,29 +12,41 @@ Recipes (e.g. `l1`, `opstack`) assemble opinionated components and pre-baked con
1212- Running repeatable CI and e2e scenarios
1313- Experimenting with fork configurations and client combinations
1414
15- Quick start:
15+ ## Installation
16+
17+ ### Install with script (recommended)
18+
19+ On Linux and macOS, you can install the latest version to ` /usr/local/bin ` with:
1620
1721``` bash
18- # L1 environment with mev-boost relay
19- builder-playground start l1
22+ curl -sSfL https://raw.githubusercontent.com/flashbots/builder-playground/main/install.sh | bash
23+ ```
2024
21- # L2 OpStack with external builder support
22- builder-playground start opstack --external-builder http://localhost:4444
25+ If you need to install a specific version, you can use the ` VERSION ` env var in the beginning like:
26+ ``` bash
27+ VERSION=1.2.3 curl -sSfL https://raw.githubusercontent.com/flashbots/builder-playground/main/install.sh | bash
2328```
2429
25- ## Installation
30+ ### Install from repository
2631
27- ```
28- $ go install github.com/flashbots/builder-playground@latest
32+ Extend the ` PATH ` variable with ` GOPATH/bin ` (or ` GOBIN ` if set), then clone the repository and do:
33+ ``` bash
34+ go install .
2935```
3036
31- or clone the repository and do:
37+ ---
3238
33- ```
34- $ go install .
35- ```
39+ These commands install to different directories as mentioned above so make sure to verify with ` which $(builder-playground) ` to avoid confusion!
3640
37- or do ` go build . ` and run from the repository like ` ./builder-playground ` .
41+ ## Quick Examples
42+
43+ ``` bash
44+ # L1 environment with mev-boost relay
45+ builder-playground start l1
46+
47+ # L2 OpStack with external builder support
48+ builder-playground start opstack --external-builder http://localhost:4444
49+ ```
3850
3951## CI / GitHub Actions
4052
0 commit comments