https://github.com/ghztomash/vpn-status
A simple library and cli tool to determine whether VPN is configured.
https://github.com/ghztomash/vpn-status
Last synced: about 1 year ago
JSON representation
A simple library and cli tool to determine whether VPN is configured.
- Host: GitHub
- URL: https://github.com/ghztomash/vpn-status
- Owner: ghztomash
- License: apache-2.0
- Created: 2024-03-19T08:50:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-27T15:08:51.000Z (almost 2 years ago)
- Last Synced: 2025-01-19T13:15:18.042Z (over 1 year ago)
- Language: Rust
- Size: 73.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VPN Status
This CLI application checks the status of a VPN connection.
It is highly customizable and is intended to be used in combination with tools like `zsh` and `tmux` as status indicator.
## Usage
By default, the application will print the status of the VPN connection to the standard output in color.
```sh
vpn-status
```
## Installation
Install the application with `cargo`:
```sh
cargo install vpn-status
```
Alternatively, you can build the application from source:
```sh
git clone https://github.com/ghztomash/vpn-status.git
cd vpn-status
cargo install vpn-status --path .
# or
cargo build --release
cp ./target/release/vpn-status /usr/local/bin
```
## Configuration
The default configuration is stored in `./.config/vpn_status/config.toml`
Load a specified configuration with `--config-path ` flag, If the configuration file is not found, a copy of the default configuration will be saved in that path.
## License
Licensed under either of
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.