Skip to content

Update the README with common options and commands #2621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update the README with common options and commands #2621

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e04e8a0
add common commands and important options
camembera Mar 21, 2025
61aa756
close `
camembera Mar 21, 2025
5105257
Update README.md
camembera Apr 30, 2025
2ca0155
Update README.md
camembera Apr 30, 2025
ad3f4ad
Merge branch 'main' into fix/README-for-noobs
abi87 Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,25 @@ preloaded with the native EVM token.
## Multinode Local Devnet

Please refer to the [Kurtosis README](https://github.com/berachain/beacon-kit/blob/main/kurtosis/README.md) for more information on how to run a multinode local devnet.

## Important Commands and Options

`beacond help` lists available commands. Some commands have sub-commands.

`beacond init` creates a folder structure for beacond to operate in, along with initial configuration files, the important ones being `app.toml` and `config.toml`.

`beacond start` starts the chain client and begins the syncing process.

The key configuration value is the Beacon chain specification ("chainspec") - analogous to an Eth genesis - is held in a spec.toml file. There are three well-known chainspecs (`mainnet|testnet|devnet`). Or, a custom file can be provided to provide your own scenario's settings - see this [example using Docker](https://docs.berachain.com/nodes/guides/docker-devnet).

The chainspec is set with the `--beacon-kit.chain-spec` command line option, and if necessary for a custom chainspec, use `--beacon-kit.chain-spec-file`. If used during `beacond init`, this value is written into app.toml and does not need to be specified anymore.

You can override the default operating directories for beacond with the `--home <path>` option.

The [Berachain Node Quickstart](https://docs.berachain.com/nodes/quickstart) provides a quick deployment of mainnet or testnet on your desk.

For developing with beacon-kit, you have options:
1. see the Makefile for targets to start stand-alone processes
2. see [an example deploying a team with Docker on a custom chainspec](https://docs.berachain.com/nodes/guides/docker-devnet)
3. see [a deployment with Kurtosis](https://docs.berachain.com/nodes/guides/kurtosis)
4. see [an expect script that does a complete cycle of deposits, withdrawal, eviction, voluntary exit](https://github.com/berachain/guides/blob/main/apps/local-docker-devnet/devnet-automation.exp)