Home

Awesome

<h2 align="center"> Private Internet Access Tmux Plugin</h2> <p align="center"><img src="https://raw.githubusercontent.com/Brutuski/tmux-piavpn/c4b5c5b8a01e0e81d8bc86bcb76cd72c4490e57c/assets/Logo.svg" width="200" height="200"><p> <p align="center"> <img alt="Status" src="https://img.shields.io/badge/Maintained-Yes-44B273.svg"> <img alt="License" src="https://img.shields.io/badge/LICENSE-MIT-1D918B.svg"> </p>

Index

Getting Started

Monitor the status of your Private Internet Access VPN from your Tmux statusbar. With this plugin, you can display the following information:

Screenshots

<p align="center"><img src="https://raw.githubusercontent.com/Brutuski/tmux-piavpn/main/assets/demo.gif"><p> <p align="center"><img src="https://raw.githubusercontent.com/Brutuski/tmux-piavpn/main/assets/screenshot2.png"><p> <p align="center"><img src="https://raw.githubusercontent.com/Brutuski/tmux-piavpn/main/assets/screenshot1.png"><p> <p align="center"><img src="https://raw.githubusercontent.com/Brutuski/tmux-piavpn/main/assets/screenshot3.png"><p>

Format strings can be edited to show as much informaion as the user wants. Terminal and Tmux theme shown here is Lighthaus

Tmux Lighthaus theme coming soon

Requirements

Installation

Recommended method:

Manual Installation:

Usage

Options

Options available for changing the status text:

# Format string for connected status
# Default text `Connected`
set -g @piavpn_text_connected "Con"

# Format string for disconnected status
# Default text `Disconnected`
set -g @piavpn_text_disconnected "Dis"

# Format string for connecting status
# Default text `Connecting...`
set -g @piavpn_text_connecting "Con..."

# Format string for disconnecting status
# Default text `Disconnecting...`
set -g @piavpn_text_disconnecting "Dis..."

# Format string for interrupted status
# Default text `Interrupted`
set -g @piavpn_text_interrupted "Intr."

# Format string for reconnecting status
# Default text `Reconnecting`
set -g @piavpn_text_reconnecting "Recon..."

# Format string for disconnecting to reconnect status
# Default text `Connecting again...`
set -g @piavpn_text_disconnecting_reconnecting "Con. again..."

# Format string for still connecting status
# Default text `Reconnecting...`
set -g @piavpn_text_still_reconnecting "Recon. again..."

Example

Format strings can be edited to what the user needs. fg and bg colors can be defined by the user as well.

# PIA VPN
set -g @piavpn_text_connected "Conn."
set -g @piavpn_text_disconnected "Dis."
set -g @piavpn_text_connecting "Conn..."
set -g @piavpn_text_disconnecting "Dis..."
set -g @piavpn_text_interrupted "Interr."
set -g @piavpn_text_reconnecting "Reconn..."
set -g @piavpn_text_disconnecting_reconnecting "Conn. again..."
set -g @piavpn_text_still_reconnecting "Reconn. again..."

set -g status-left "......#[fg=#21252D,bg=#50C16E] PIA: #{pia_status} #{pia_flag}  "

Changelog

v1.0.0

Changes can be tracked in the CHANGELOG

Issues

Please report any bugs or issues here

License

MIT

Copyright (c) 2021 Adhiraj Sirohi

Logo Credit

Logo was made by Vasundhara Sharma <a href="https://www.behance.net/vasundhsharma" target="blank"><img align="center" src="https://raw.githubusercontent.com/detain/svg-logos/780f25886640cef088af994181646db2f6b1a3f8/svg/behance-1.svg" alt="https://www.behance.net/vasundhsharma" height="40" width="40"/></a> <a href="https://keybase.io/vas_sharma" target="blank"><img align="center" src="https://www.vectorlogo.zone/logos/keybase/keybase-icon.svg" alt="https://keybase.io/vas_sharma" height="40" width="40"/></a>