⌨️ Hack-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

Run the build or download the latest cli(WIP).

Note

We do not have pre-built binaries yet. If you are comfortable doing so, you are welcome to build it yourself and provide feedback.

Building

1. Clone the repository

git clone https://github.com/algorandfoundation/hack-tui.git

2. Change to the project directory

cd hack-tui

3. Run the build command

make build

4. Start a participation node

docker compose up

Note

The docker image is used for development and testing purposes. TUI will also work with native algod. If you have a node installed already, you can skip this step.

5. Connect to the node

./bin/algorun --server http://localhost:8080 --token aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

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.

Note

If you skipped the docker container, try running ./bin/algorun standalone, which will detect your algorand data directory from the ALGORAND_DATA environment variable that works for goal. Otherwise, provide the --server and --token arguments so that it can find your node. Note that algorun requires the admin algod token.

ℹ️ Usage

⚙️ Configuration

Configuration is loaded in the following order:

1. Configuration file (.algorun.yaml)
   1. Current Directory
   2. Home Directory
   3. /etc/algorun/
2. ENV Configuration
   • ALGORUN_*
3. CLI Flag Arguments
4. ALGORAND_DATA parsing

This results in ALGORAND_DATA taking precedence in the loading order.

.algorun.yaml

Example configuration file:

server: "http://localhost:8080"
token: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Environment Variables

Name	Example
ALGORUN_SERVER	ALGORUN_SERVER="http://localhost:8080"
ALGORUN_TOKEN	ALGORUN_TOKEN="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Flags

The application supports the server and token flags for configuration.

algorun --server http://localhost:8080 --token aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

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

🧑‍💻 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