agrarian/doc/build-menu.md

Interactive Build Menu

contrib/agrarian-build-menu.sh provides an interactive Ubuntu build workflow for common Agrarian targets:

• Linux daemon and CLI tools
• Linux Qt GUI wallet
• Windows daemon and CLI tools
• Windows Qt GUI wallet
• Linux ARM64 daemon and CLI tools
• Linux ARM64 Qt GUI wallet

The script clones the Agrarian repository if the selected checkout directory does not exist. If the checkout already exists, it fetches, checks out the configured branch, and performs a fast-forward pull.

Only bootstrap packages needed to update the checkout are installed before the pull. Target-specific packages are installed after the checkout is current, so fresh dependency fixes on the selected branch are applied before the build. After updating the checkout, the launcher restarts itself from the checked-out copy so the current branch version of the menu is used for package installation and build steps. The selected target, checkout directory, and job count are preserved across that restart.

Quick Start

From an existing checkout:

./contrib/agrarian-build-menu.sh

Do not run the script with sudo. It runs checkout, compilation, daemon config, and the user systemd service as the current local user. It asks for sudo only when it needs to install Ubuntu packages or set MinGW compiler alternatives.

From a fresh Ubuntu host:

sudo apt-get update
sudo apt-get install -y git ca-certificates
git clone --branch 2.0 https://github.com/pacificao/agrarian.git agrarian
cd agrarian
./contrib/agrarian-build-menu.sh

On minimal VPS images, apt sources may be incomplete. The script checks for missing Ubuntu -updates and -security suites before installing build packages. If they are missing, it asks before adding a standard /etc/apt/sources.list.d/agrarian-ubuntu.sources file for the host architecture.

The Linux daemon option uses the deterministic native depends/ build with Qt disabled, so Berkeley DB and other core libraries are built inside the checkout instead of being required as Ubuntu system development packages.

The Linux Qt wallet option also installs Ubuntu desktop development headers needed by Qt's xcb platform plugin, including fontconfig, freetype, xcb, and xkbcommon packages. Expat 2.8.0 and FreeType 2.14.3 are built through depends/ for the Linux Qt/font stack. Protobuf is not required because obsolete BIP70 payment request support was removed. The helper also clears stale Qt work directories before rebuilding, because failed CMake feature checks can otherwise be cached between attempts.

The Linux ARM64 daemon option cross-compiles the daemon and CLI tools from an x86_64 Ubuntu host when the g++-aarch64-linux-gnu and binutils-aarch64-linux-gnu packages are available. On an ARM64 Ubuntu host it uses the normal native Linux daemon path.

The Linux ARM64 Qt wallet option is native-only. Run it on an ARM64 Ubuntu desktop/server with the Qt/XCB development packages installed. The current Qt 6 Linux wallet build depends on target-system XCB/font pkg-config metadata, so the menu does not advertise a fragile x86_64-to-ARM64 Qt GUI cross-build path.

Defaults

The script can be configured with environment variables:

REPO_URL=https://github.com/pacificao/agrarian.git
BRANCH=<current checkout branch, or main when run standalone>
WORKDIR=$HOME/agrarian
JOBS=<detected CPU count>

Example:

JOBS=8 WORKDIR=$HOME/src/agrarian ./contrib/agrarian-build-menu.sh

To test the 2.0 branch from a standalone downloaded copy of the script:

BRANCH=2.0 ./agrarian-build-menu.sh

Linux Daemon Autostart

After a Linux daemon-capable build, the script asks whether to install and start agrariand for the current user. If accepted, it creates:

• $HOME/.local/bin/agrariand
• $HOME/.local/bin/agrarian-cli
• $HOME/.agrarian/agrarian.conf
• $HOME/.config/systemd/user/agrariand.service

It then enables and starts the user service with:

systemctl --user enable --now agrariand.service

Windows Build Output

For Windows targets, the script prints the .exe artifact paths when the build finishes. Copy the generated files from src/ and src/qt/ to the Windows machine and run either agrariand.exe or agrarian-qt.exe.

ARM64 Build Output

For ARM64 daemon targets, the script prints the generated Linux binaries in src/. Copy them to the ARM64 machine if the build was cross-compiled. For the ARM64 Qt wallet target, the build should be run directly on the ARM64 machine and the wallet binary is src/qt/agrarian-qt.