install.md

order
3

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

Compile with RocksDB support

Install RocksDB.

Ubuntu:

sudo apt-get update

git clone https://github.com/facebook/rocksdb.git
cd rocksdb

DEBUG_LEVEL=0 make shared_lib install-shared

export LD_LIBRARY_PATH=/usr/local/lib

OSX:

brew install rocksdb

Set a database backend to rocksdb:

# config/config.toml
db_backend = "rocksdb"

To install CometBFT, run:

make install COMETBFT_BUILD_OPTIONS=rocksdb

or run:

make build COMETBFT_BUILD_OPTIONS=rocksdb

which puts the binary in ./build.