ralertsinua

Install v0.5.2

Published on May 20 2024 at 20:11 UTC
View all installation options
View all installation options

Quality Gate Status Coverage Status Crates.io Version Crates.io License docs.rs Stand With Ukraine

Stand With Ukraine

ralertsinua

Rust async API wrapper (reqwest) & TUI (ratatui) for alerts.in.ua

screencast

Introduction

The Alerts.in.ua API Client is a Rust library that simplifies access to the alerts.in.ua API service. It provides real-time information about air raid alerts and other potential threats.

Installation

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/voiceapiai/ralertsinua/releases/download/v0.5.0/ralertsinua-installer.sh | sh

Download prebuilt binaries from the releases page

Usage

⚠️ Before you can use this library, you need to obtain an API token by submitting an API request form.

⚠️ Provide token via environment variable ALERTSINUA_TOKEN or via --token flag. If empty, the library will try to ask you interactively one time.

export ALERTSINUA_TOKEN="your_token"; ralertsinua

# or

ralertsinua --token "your_token"

Default polling interval is 30 seconds. You can change it via ALERTSINUA_POLLING_INTERVAL_SEC env or --interval flag.

export ALERTSINUA_POLLING_INTERVAL_SEC=60; ralertsinua

# or

ralertsinua --interval 60

License

MIT 2024

Inspitation & Credits & Thanks

History

Star History Chart

*[TUI]: Terminal User Interface

window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date());gtag('config', 'G-TCJ5D14XV4');