# Text User Interface (TUI)

## Harmony TUI

Text based user interface for Harmony node.\
Below information is currently displayed on Harmony-TUI

1. **Section - Harmony Blockchain** - Connected peers - Leader's one address - Current epoch number - Recent timestamps of various stages
2. **Section - Harmony Node** - Harmony node binary version - ShardId of local node - Balance of user's one account
3. **Section - Current Block** - Current block number - Size of current block in bytes - Hash of current block - StateRoot - BlockEpoch - Number of signers who signed last block
4. **Section - System Stats** - CPU usage in percentage - Memory/RAM usage of system - Used disk space
5. **Section - Validator Logs** This section shows validator log file

## Dependencies

1. Harmony node running on localhost:9000
2. Shared libraries required for running harmony node
3. Harmony TUI binary should be in same directory as harmony node binary

## Build and run harmony-tui binary

**Build from source code**

1. Clone repository - `git clone git@github.com:harmony-one/harmony-tui.git`
2. `cd harmony-tui`
3. Invoke `make` to build `harmony-tui` binary for local platform or `make build-linux` for linux
4. binary will get generated in `./bin` directory
5. Copy harmony-tui binary from `./bin` to the same directory as harmony node binary
6. Invoke binary - `path_to_binary/harmony-tui --address=YOUR_ONE_ADDRESS`

**Download binary and run .**

1. Download binary directly from [here](http://harmony.one/tui).
2. Place downloaded binary in same directory as harmony node binary
3. Invoke binary - `path_to_binary/harmony-tui --address=YOUR_ONE_ADDRESS`

## Usage

1. Invoke binary - `path_to_binary/harmony-tui --address=YOUR_ONE_ADDRESS`
2. Help information - `path_to_binary/harmony-tui--help`
3. Command line arguments supported by harmony-tui binary\
   `-address string`

   ```
       `address of your one account (default "Not Provided")`
   ```

   `-env string`

   ```
       `environment of system binary is running on option 1- "local" option 2- "ec2" (default "ec2")`
   ```

   `-version`

   ```
       `version of the binary`
   ```

**Examples**

1. Run binary - `path_to_binary/harmony-tui --address=YOUR_ONE_ADDRESS --env=local`
2. Check version - `path_to_binary/harmony-tui --version`

## Sample GIF​[​](https://raw.githubusercontent.com/harmony-one/harmony-tui/master/doc/images/tui-sample.gif?token=AEY7S2JV6DIWLODPOXCKMN25VED6W) <a href="#sample-screenshot" id="sample-screenshot"></a>

![](https://raw.githubusercontent.com/harmony-one/harmony-tui/master/doc/images/tui-sample.gif?token=AEY7S2JV6DIWLODPOXCKMN25VED6W)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.harmony.one/home/network/validators/tools/text-user-interface-tui.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.