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 2 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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,17 @@ 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 environment variable is `CHAIN_SPEC`, which can be set to `mainnet`, `testnet`, or `devnet`. This should be set any time when using beacond. It will influence which configuration files you get during `init` and which chain ID beacond will communicate with while running.

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 complete example of a functioning setup, suitable for a development system or for experiments.
Loading