Skip to content

README.md

Latest commit

 

History

History
71 lines (48 loc) · 1.41 KB

README.md

File metadata and controls

71 lines (48 loc) · 1.41 KB

audion

Ping a host continuously and write results to a file. The tool send ICMP Type 8 (echo) requests to check if the target is "on".

sudo is required to execute the tool.

Installation

Clone the repository and use cargo to build the package.

For Nix or NixOS users is a package available in Nixpkgs. Keep in mind that the lastest releases might only be present in the unstable channel.

$ nix-env -iA nixos.audion

Usage

The tool requires elevated permissions. Thus, run it with sudo or doas.

$ sudo audion -h
Name:
	audion

Author:
	Fabian Affolter <fabian.affolter@audius.de>

Description:
	Ping the host continuously and write results to a file

Usage:
	audion [args]

Flags:
	-t, --target <string> : Target host to ping
	-o, --output <string> : Output file to write results
	-to, --timeout <int>  : Timeout in milliseconds
	-i, --interval <int>  : Interval between pings in seconds
	-h, --help            : Show help

Version:
	0.1.0

Development

Run tests:

$ nix-shell --run "cargo test"

Build everything:

$ nix-shell --run "cargo clean && cargo build"

Run the app:

$ nix-shell --run "cargo run -- --host 127.0.0.1 --port 8080 --wt-port 4433"

License

audion is licensed under MIT, for more details check the LICENSE file.