install.md

order
1

Install CometBFT

From Go Package

Install the latest version of CometBFT's Go package:

go install github.com/cometbft/cometbft/cmd/cometbft@latest

Install a specific version of CometBFT's Go package:

go install github.com/cometbft/cometbft/cmd/[email protected]

From Binary

To download pre-built binaries, see the releases page.

From Source

You'll need go installed and the required environment variables set, which can be done with the following commands:

echo export GOPATH=\"\$HOME/go\" >> ~/.bash_profile
echo export PATH=\"\$PATH:\$GOPATH/bin\" >> ~/.bash_profile

Get Source Code

git clone https://github.com/cometbft/cometbft.git
cd cometbft

Compile

make install

to put the binary in $GOPATH/bin or use:

make build

to put the binary in ./build.

DISCLAIMER The binary of CometBFT is build/installed without the DWARF symbol table. If you would like to build/install CometBFT with the DWARF symbol and debug information, remove -s -w from BUILD_FLAGS in the make file.

The latest CometBFT is now installed. You can verify the installation by running:

cometbft version

Reinstall

If you already have CometBFT installed, and you make updates, simply

make install

To upgrade, run

git pull origin main
make install