https://github.com/Mk555/pagerduty-tui

Minimalistic terminal UI to manage triggered incidents
https://github.com/Mk555/pagerduty-tui

Last synced: 10 days ago
JSON representation

Minimalistic terminal UI to manage triggered incidents

• Host: GitHub
• URL: https://github.com/Mk555/pagerduty-tui
• Owner: Mk555
• License: agpl-3.0
• Created: 2024-04-09T05:51:59.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-10T16:11:57.000Z (9 months ago)
• Last Synced: 2024-04-10T20:58:47.082Z (9 months ago)
• Language: Rust
• Size: 108 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-tuis - pagerduty-tui

README

        
# PagerDuty TUI

PagerDuty TUI is a minimalist terminal user interface developed in Rust for managing incidents in PagerDuty. It provides a simple interface to list triggered incidents, acknowledge them, and open them in your default browser.

![Screenshot](DOC/pagerduty-tui-screenshot.png)

## Installation

Download the last release on [Gihtub Releases](https://github.com/Mk555/pagerduty-tui/releases/latest)

## Shortcuts

Here are the options in the app : 

- `Q/` : Quit

- `//` : Move in the list of incidents

- `R` : Refresh the list of incidents

- `` : Acknowledge incident

- `A` : Acknowledge all the incidents in the service

- `G` : Trigger the switch to show incidents assigned to everyone, not only the current user

- `` : Open the incident in the default browser

## Update

To update, run the self update : 

`pagerduty-tui update`

## Build

To install Cargo, follow the steps here : 

`https://doc.rust-lang.org/cargo/getting-started/installation.html`

Then compile the app :

`cargo build`

The binary will be stored here : `./target/debug/pagerduty-tui`

## Configuration

PagerDuty TUI requires a configuration file located at `~/.config/pagerduty_tui.yaml`. This configuration file is used to store your PagerDuty API key, which is necessary for accessing PagerDuty incident data.

### Create Pager Duty API Key

![Create PagerDuty API Key](DOC/PagerDutyApiKey.png "PagerDutyApiKey")

### Configuration File Format

The configuration file should be in YAML format and be stored in `~/.config/pagerduty_tui.yaml` 

You need to put you PagerDuty API Key in this value :

```yaml

pagerduty_api_key: 

pagerduty_domain: 

```

Replace `` with your actual PagerDuty API key. This key is required for authenticating requests to the PagerDuty API and accessing incident data.

Replace `` with the name of your organization

By default the refresh time is 30 seconds, but you can change it with the following configuration :

`refresh_rate: `

Replace `` by the number of seconds between 2 refresh.

## Usage

After installation, you can run PagerDuty TUI by executing the following command in your terminal:

`pagerduty-tui`

## Key Bindings

 - `Arrow Up/Down`: Navigate incidents

 - `r`: Update incident list

 - `Enter`: Open incident in default browser

 - `a`: Acknowledge incident

 - `h`: Hide Acknowledged incidents

 - `q`: Quit PagerDuty TUI

### Contributions

Contributions to PagerDuty TUI are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.

License

This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.