Skip to content

Latest commit

 

History

History
124 lines (85 loc) · 2.94 KB

README.md

File metadata and controls

124 lines (85 loc) · 2.94 KB
Raw

⌨️ Hack-TUI

Terminal Render

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

🚀 Get Started

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

Building

Clone the repository

git clone [email protected]:algorandfoundation/hack-tui.git

Change to the project directory

cd hack-tui

Run the build command

make build

Start a participation node

docker compose up

Connect to the node

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

ℹ️ 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

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