https://github.com/edmocosta/tuistash
A Terminal User Interface for Logstash 🪵
https://github.com/edmocosta/tuistash
cli logstash logstash-tui logstash-ui terminal terminal-based tui
Last synced: 5 months ago
JSON representation
A Terminal User Interface for Logstash 🪵
- Host: GitHub
- URL: https://github.com/edmocosta/tuistash
- Owner: edmocosta
- License: apache-2.0
- Created: 2023-03-02T08:54:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-13T18:00:25.000Z (5 months ago)
- Last Synced: 2026-01-13T19:26:51.302Z (5 months ago)
- Topics: cli, logstash, logstash-tui, logstash-ui, terminal, terminal-based, tui
- Language: Rust
- Homepage:
- Size: 11.5 MB
- Stars: 104
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ratatui - tuistash - A TUI for monitoring Logstash. (💻 Apps / 🚀 Productivity and Utilities)
README
# Tuistash
A Terminal User Interface (TUI) for Logstash 🪵
## Installation
### Arch Linux
[tuistash](https://aur.archlinux.org/packages/tuistash) is available as a package in the AUR.
You can install it using an AUR helper (e.g. `paru`):
```shell
paru -S tuistash
```
### Homebrew
```shell
brew tap edmocosta/homebrew-tap
```
```shell
brew install tuistash
```
### Manual
The compiled versions can be downloaded from the [GitHub releases page](https://github.com/edmocosta/tuistash/releases).
If a version for your operating system isn't available, you can build it from the source by following these steps:
1 - Install Rust and Cargo (Linux and macOS):
```shell
curl https://sh.rustup.rs -sSf | sh
```
2 - Clone the repository:
```shell
git clone https://github.com/edmocosta/tuistash.git
```
3 - Build the binary (`target/release/tuistash`)
```shell
cd tuistash
```
```shell
cargo build --release
```
## Usage
The Logstash's [monitoring API](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html) must be enabled
and accessible from the client machine, unless the data is being read from a Logstash diagnostic path.
By default, the data is polled every 1 second. If you have very complex pipelines, increasing the refresh interval (`--interval`) might
improve the UI performance.
```shell
$ ./tuistash --help
```
```shell
Usage: tuistash [OPTIONS] [COMMAND]
Commands:
get Query data from the Logstash API
tui Logstash TUI
help Print this message or the help of the given subcommand(s)
Options:
--host [default: http://localhost:9600]
--username
--password
--skip-tls-verification
-p, --diagnostic-path Read the data from a Logstash diagnostic path
-h, --help Print help
-V, --version Print version
```
### TUI
```shell
./tuistash
```
```shell
./tuistash tui --help
```
```shell
Logstash TUI
Usage: tuistash tui [OPTIONS]
Options:
-i, --interval Refresh interval in seconds [default: 1]
```
### Other commands
#### GET
```shell
./tuistash get node --help
```
```shell
Prints the current node information
Usage: tuistash get node [OPTIONS] [TYPES]
Arguments:
[TYPES] Valid values are 'node', 'os', 'jvm', 'pipelines' separated by comma
Options:
-o Valid values are 'json', 'raw'
```
Examples:
```shell
./tuistash get node pipelines,os
```
```shell
./tuistash get node jvm -o raw
```