https://github.com/stchris/aleph-tui

A text user interface for Aleph
https://github.com/stchris/aleph-tui

aleph ratatui rust tui

Last synced: about 2 months ago
JSON representation

A text user interface for Aleph

• Host: GitHub
• URL: https://github.com/stchris/aleph-tui
• Owner: stchris
• License: gpl-3.0
• Created: 2024-01-19T22:30:46.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-11-20T18:42:10.000Z (about 2 months ago)
• Last Synced: 2024-11-20T19:36:26.806Z (about 2 months ago)
• Topics: aleph, ratatui, rust, tui
• Language: Rust
• Homepage:
• Size: 327 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# aleph-tui

This is a text UI for [aleph](https://www.github.com/alephdata/aleph). It allows one to monitor the status of an Aleph instance in real time. It uses the Aleph API to retrieve this information and shows roughly the same data one would see on Aleph's status page.

![aleph-tui](aleph-tui.png)

![aleph-tui with profile selection menu open](aleph-tui-profile-selector.png)

## Installation

Check the individual [release pages](https://github.com/stchris/aleph-tui/releases) for instructions.

On mac OS:

```sh

brew install stchris/homebrew-formulae/aleph-tui

```

## Configuration

`aleph-tui` assumes the configuration to live in `$HOME/.config/aleph-tui.toml`. It allows you to connect to multiple Aleph instances through `profiles`. Here is an example file:

```toml

default = "local"

[profiles]

  [profiles.local]

  url = "http://localhost:8080/"

  token = ""

  [profiles.my-aleph]

  url = "https://my.aleph.instance/"

  token = ""

```

Find your personal API token by going to `/settings` on your Aleph instance and copying the value from the `API Secret Access Key` field.

`default` defines the profile to be loaded when `aleph-tui` starts up.