Skip to content

Commit

Permalink
Merge pull request #31 from ethpandaops/bbusa/readme
Browse files Browse the repository at this point in the history
docs: add some basic run/remove docs
  • Loading branch information
barnabasbusa authored Jun 18, 2024
2 parents 5bb15fa + c33d69f commit cf78632
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,24 @@ ethereum_package:
- blockscout
```
## Quickstart
#### Run with your own configuration
Kurtosis packages are parameterizable, meaning you can customize your network and its behavior to suit your needs by storing parameters in a file that you can pass in at runtime like so:
```bash
kurtosis run github.com/ethpandaops/optimism-package --args-file https://raw.githubusercontent.com/ethpandaops/optimism-package/main/network_params.yaml
```

For `--args-file` you can pass a local file path or a URL to a file.

To clean up running enclaves and data, you can run:

```bash
kurtosis clean -a
```

This will stop and remove all running enclaves and **delete all data**.

## Configuration

Expand Down

0 comments on commit cf78632

Please sign in to comment.