README.md

Private Internet Access Tmux Plugin

Index

• Getting Started
• Screenshots & Demo
• Requirements
• Installation
• Usage
• Options
• Example
• Changelog
• Issues
• License
• Logo Credit

Getting Started

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

• Status of your VPN connection : #{pia_status}
• VPN IP Address : #{pia_ip}
• Connected server's country-name : #{pia_region}
• Connected server's region-flag : #{pia_flag}
• Status of Port Forwarding : #{pia_port}

Screenshots

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

• Private Internet Access VPN
• This plugin relies on piactlto work. For piactl to fully work, the PIA client must be running, this is a requirment of the VPN service itself. For more information refer to the official helpdesk source.
• TPM is the recommended method of installing this plugin

Installation

Recommended method:

• Add plugin to your TPM plugins in your .tmux.conf

  •   set -g @plugin 'Brutuski/tmux-piavpn'

• While inside a tmux session press prefix + I to reload and install the plugin.
• Add the desired format strings to your status as such

  •   #{pia_status} #{pia_flag}

• Reload the tmux config and the changes should take effect.

Manual Installation:

• Clone this repo

  •   git clone https://github.com/Brutuski/tmux-piavpn.git ~/.tmux/tmux-piavpn

• Add the following line to the bottom of your tmux config

  •   run-shell ~/.tmux/tmux-piavpn/pia.tmux

• Save the file and reload your tmux session.

Usage

• Add the desired format strings to your status as such. All supported format strings listed below in options

  •   #{pia_status} #{pia_region}

• Reload the tmux config and the changes should take effect.

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