Skip to content

Commit

Permalink
Update README (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
edmocosta authored Jun 27, 2024
1 parent 00526d6 commit 2829271
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tuistash

A Terminal User Interface for Logstash.
A Terminal User Interface (TUI) for monitoring Logstash 🪵

![demo](docs/img/demo.gif)

Expand All @@ -15,7 +15,7 @@ brew tap edmocosta/homebrew-tap
brew install tuistash
```

### Manual
### Manually
Download the latest release from the [GitHub releases page](https://github.com/edmocosta/tuistash/releases) or build it from the source:

1 - Install Rust and Cargo (Linux and macOS):
Expand Down Expand Up @@ -65,13 +65,28 @@ Options:

```

### TUI:
### TUI

```shell
./tuistash
```

### GET command:
```shell
./tuistash tui --help
```

```shell
Logstash TUI

Usage: tuistash tui [OPTIONS]

Options:
-i, --interval <INTERVAL> Refresh interval in seconds [default: 1]
```

### Other commands

#### GET

```shell
./tuistash get node --help
Expand Down

0 comments on commit 2829271

Please sign in to comment.