Skip to content

INSTALL.md

Latest commit

 

History

History
84 lines (53 loc) · 1.74 KB

INSTALL.md

File metadata and controls

84 lines (53 loc) · 1.74 KB
Raw

Nibiru Installation Guide

This guide explains how to install the Nibiru binary, nibid, from this repository.

1) Prerequisites

  • Go (see go.mod for the required version): Install Go
  • command just: Install just
  • Common build tooling (git, C compiler toolchain, curl, jq)

Example packages on Ubuntu:

sudo apt update
sudo apt install --yes git build-essential curl jq

2) Clone the Repository

git clone https://github.com/NibiruChain/nibiru
cd nibiru

3) Build and Install nibid

From the repository root, run:

just install

This builds and installs the nibid binary.

4) Start a Local Network

just localnet

Open another terminal if you want to query the node while the localnet is running.

Upgrade or Switch Versions

To switch to a specific tagged release:

git fetch --tags
git checkout <tag>
just install

For network-specific instructions:

Troubleshooting

nibid Command Not Found

If nibid is not on your PATH, add your Go bin directory:

export PATH="$PATH:$(go env GOPATH)/bin"

Then reload your shell config.

Binary Does Not Reflect Local Code Changes

Rebuild and reinstall from the repository root:

just install

Updating Protobuf-Generated Code

Use command just proto gen from the repository root.

macOS Notes

If a local command used by your shell scripts is missing, install it with Homebrew (for example, command brew install wget).