Install — steadfaste

Installation Steps

1

Clone the repository

# Clone the repository (currently private — access by invitation)
git clone <repo-url> steadfaste
cd steadfaste

2

Run the install script

The install script builds the Rust workspace in release mode and copies the steadfaste binary to a user bin directory (default: ~/.local/bin).

./install.sh

Or specify a custom directory:

./install.sh --dir /usr/local/bin

Or via environment variable:

STEADFASTE_INSTALL_DIR=/usr/local/bin ./install.sh

3

Verify the installation

steadfaste --version
steadfaste status

You should see the binary run successfully. If ~/.local/bin is not in your PATH, add it:

export PATH="$PATH:$HOME/.local/bin"

4

Configure

Copy the example configuration and edit to taste:

cp .env.example .env

steadfaste uses one validated configuration rather than sprawling environment variables. Unknown configuration is rejected rather than silently ignored.

From Source (Manual)

If you prefer to build without the install script:

# Build the core workspace (14 crates, ~17K LOC)
cd core
cargo build --release -p steadfaste

# Or build all workspace binaries:
#   steadfaste-core   — Constitution binary (serve, stdin, status, version)
#   steadfaste-client — Reusable Wire client
#   steadfaste        — TUI + CLI wrapper
#   steadfaste-gateway — Telegram transport
cargo build --release

# Binaries will be at:
# core/target/release/steadfaste*

# Copy to your PATH
cp target/release/steadfaste ~/.local/bin/

Update

steadfaste is intentionally conservative: no automatic updates. You decide when to pull and rebuild.

cd steadfaste
git pull origin main
./install.sh

Release promotion

Changes in steadfaste move deliberately through:

develop → soak → candidate → stable

A working production system should not suddenly become a different system because an upstream released a new version. You choose when to promote.

Uninstall

rm ~/.local/bin/steadfaste

Remove the associated config in your working directory if desired. The Ledger and state files are in their own paths — review the spec for cleanup.

Install steadfaste