Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.18 KB

README.md

File metadata and controls

37 lines (24 loc) · 1.18 KB
Raw

aleph-tui

This is a text UI for 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 with profile selection menu open

Installation

Check the individual release pages for instructions.

On mac OS:

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:

default = "local"

[profiles]
  [profiles.local]
  url = "http://localhost:8080/"
  token = "<YOUR API TOKEN HERE>"

  [profiles.my-aleph]
  url = "https://my.aleph.instance/"
  token = "<YOUR API TOKEN HERE>"

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.