⌨️ AlgoRun-TUI

---

Terminal UI for managing Algorand nodes. Built with bubbles & bubbletea

Caution

This project is in alpha state and under heavy development. We do not recommend performing actions (e.g. key management) on participation nodes connected to public networks.

🚀 Get Started

Download the latest release by running

curl -fsSL https://raw.githubusercontent.com/algorandfoundation/algorun-tui/refs/heads/main/install.sh | bash

Launch the TUI by replacing the <ENDPOINT> and <TOKEN> with your server in the following example

Important

TUI requires the admin token in order to access participation key information. This can be found in the algod.admin.token file, e.g. /var/lib/algorand/algod.admin.token

./algorun --algod-endpoint <ENDPOINT> --algod-token <TOKEN>

ℹ️ Advanced Usage

🧑‍💻 Commands

The default command will launch the full TUI application

./algorun

Status

Render only the status overview in the terminal

./algorun status

Help

Display the usage information for the command

./algorun help

⚙️ Configuration

Configuration precedence takes place in the following order:

1. ALGORAND_DATA Parsing
2. Configuration File
3. Environment Variables
4. Command Line Flag Arguments

Flags

The application supports the algod-endpoint and algod-token flags for configuration.

./algorun --algod-endpoint http://localhost:8080 --algod-token aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

Configuration File

The configuration file is named .algorun.yaml and is loaded in the following order:

1. Current Directory
2. Home Directory
3. /etc/algorun/

Example .algorun.yaml configuration file:

algod-endpoint: "http://localhost:8080"
algod-token: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Environment Variables

Environment variables can be set in order to override a configuration or ALGORAND_DATA setting but cannot be used to override the command line arguments.

The following are the additional ENV variables the TUI supports

Name	Example
ALGORUN_ALGOD-ENDPOINT	ALGORUN_ALGOD-ENDPOINT="http://localhost:8080"
ALGORUN_ALGOD-TOKEN	ALGORUN_ALGOD-TOKEN="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

ALGORAND_DATA

The TUI searches the environment for an ALGORAND_DATA variable. It then loads the algod-token and algod-endpoint values from the algod data directory.