Metadata-Version: 2.1
Name: protonvpn-cli
Version: 2.2.11
Summary: Linux command-line client for ProtonVPN
Home-page: https://github.com/protonvpn/linux-cli-community
Author: Proton Technologies AG
Author-email: contact@protonvpn.com
License: GPLv3
Description: 
        <h1 align="center">ProtonVPN-CLI</h1>
        <p align="center">
          <img src="resources/images/linux-cli-banner.png" alt="Logo"></img>
        </p>
        
        <p align="center">
            <a href="https://pepy.tech/project/protonvpn-cli"><img alt="Downloads" src="https://pepy.tech/badge/protonvpn-cli"></a>
            <img alt="GitHub" src="https://img.shields.io/github/license/ProtonVPN/linux-cli">
            <a href="https://pepy.tech/project/protonvpn-cli/week"><img alt="Downloads per Week" src="https://pepy.tech/badge/protonvpn-cli/week"></a>
            <br>
            <a href="https://twitter.com/ProtonVPN"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/ProtonVPN?style=social"></a>
            <a href="https://www.reddit.com/r/ProtonVPN"><img alt="Subreddit subscribers" src="https://img.shields.io/reddit/subreddit-subscribers/ProtonVPN?label=Join%20r%2FProtonVPN&style=social"></a>
        </p>
        
        <h3 align="center">A Linux CLI for ProtonVPN. Written in Python.</h3>
        
        ProtonVPN-CLI is a full rewrite of the [bash protonvpn-cli](https://github.com/ProtonVPN/protonvpn-cli/blob/master/protonvpn-cli.sh) in Python, which adds more features and functionality with the purpose of improving readability, speed and reliability.
        
        ## Important information
        The [official ProtonVPN Linux](https://protonvpn.com/blog/protonvpn-linux-app/) app is available for Debian 10, Ubuntu 20+, Mint 19+, MX Linux 19+, Fedora 31+ and Archlinux / Manjaro. Where possible, we recommend that you [upgrade to the official app](https://protonvpn.com/support/linux-vpn-setup/).
        The community Linux client described below remains available for those who need it.
        
        ## Installation & Updating
        
        For more detailed information on installing, updating and uninstalling, please view the extensive [usage guide](https://github.com/ProtonVPN/linux-cli-community/blob/master/USAGE.md#installation--updating).
        
        ### Installing from distribution repositories
        
        For the following Linux distribution(s), install the official `protonvpn-cli` package:
        
        #### Fedora
        
        ```sh
        sudo dnf install -y protonvpn-cli
        ```
        
        #### CentOS & RHEL
        
        `protonvpn-cli` is available for CentOS/RHEL 7.x and 8.x via the [EPEL repositories](https://fedoraproject.org/wiki/EPEL).
        
        **For CentOS/RHEL 7.x**:
        
        ```sh
        sudo yum install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
        sudo yum install protonvpn-cli
        ```
        
        **For CentOS/RHEL 8.x**:
        
        ```sh
        sudo dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
        sudo dnf install -y protonvpn-cli
        ```
        
        ### Installing from PyPI
        
        #### Installing Dependencies
        
        **Dependencies:**
        
        - openvpn
        - dialog (optional, needed for interactive selection)
        - pip for python3 (pip3)
        - python3.5+
        - setuptools for python3 (python3-setuptools)
        
        Depending on your distribution, run the appropriate following command to install the necessary dependencies
        
        | **Distro**                              | **Command**                                                        |
        |:----------------------------------------|:------------------------------------------------                   |
        |Fedora/CentOS/RHEL                       | `sudo dnf install -y openvpn dialog python3-pip python3-setuptools`|
        |Ubuntu/Linux Mint/Debian and derivatives | `sudo apt install -y openvpn dialog python3-pip python3-setuptools`|
        |OpenSUSE/SLES                            | `sudo zypper in -y openvpn dialog python3-pip python3-setuptools`  |
        |Arch Linux/Manjaro                       | `sudo pacman -S openvpn dialog python-pip python-setuptools`       |
        
        #### Installing ProtonVPN-CLI
        
        Installation happens via Python's package manager PIP.
        
        *Note: Make sure to run pip with sudo, so it installs globally and recognizes the command with sudo*
        
        `sudo pip3 install protonvpn-cli`
        
        #### Updating ProtonVPN-CLI
        
        `sudo pip3 install protonvpn-cli --upgrade`
        
        ### Manual Installation from source
        
        *Disclaimer: If you are unsure about what you're doing, please follow the [normal installation guide](https://github.com/ProtonVPN/linux-cli-community/blob/master/USAGE.md#installation--updating).*
        
        It is recommended to do the manual installation in a virtual environment. Especially if it serves the purpose of developing.
        
        1. Clone this repository
        
            `git clone https://github.com/ProtonVPN/linux-cli-community`
        
        2. Step into the directory
        
           `cd linux-cli`
        
        3. Install
        
            `pip3 install -e .`
        
        For updating, you just need to pull the latest version of the repository with git.
        
        ### How to use
        
        #### For more detailed information, see the extensive [usage guide](https://github.com/ProtonVPN/linux-cli-community/blob/master/USAGE.md).
        
        | **Command**                       | **Description**                                       |
        |:----------------------------------|:------------------------------------------------------|
        |`protonvpn init`                   | Initialize ProtonVPN profile.                         |
        |`protonvpn connect, c`             | Select a ProtonVPN server and connect to it.          |
        |`protonvpn c [servername]`         | Connect to a specified server.                        |
        |`protonvpn c -r`                   | Connect to a random server.                           |
        |`protonvpn c -f`                   | Connect to the fastest server.                        |
        |`protonvpn c --p2p`                | Connect to the fastest P2P server.                    |
        |`protonvpn c --cc [countrycode]`   | Connect to the fastest server in a specified country. |
        |`protonvpn c --sc`                 | Connect to the fastest Secure Core server.            |
        |`protonvpn reconnect, r`           | Reconnect or connect to the last server used.         |
        |`protonvpn disconnect, d`          | Disconnect the current session.                       |
        |`protonvpn status, s`              | Print connection status.                              |
        |`protonvpn configure`              | Change CLI configuration.                             |
        |`protonvpn refresh`                | Refresh OpenVPN configuration and server data.        |
        |`protonvpn examples`               | Print example commands.                               |
        |`protonvpn --version`              | Display version.                                      |
        |`protonvpn --help`                 | Show help message.                                    |
        
        All connect options can be used with the `-p` flag to explicitly specify which transmission protocol is used for that connection (either `udp` or `tcp`).
        
        ## Contributing
        
        If you want to contribute to this project, please read the [contribution guide](https://github.com/ProtonVPN/linux-cli-community/blob/master/CONTRIBUTING.md).
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/markdown
