https://github.com/ProtonVPN/linux-cli

Official ProtonVPN Linux app (CLI)
https://github.com/ProtonVPN/linux-cli

cli linux python vpn

Last synced: about 2 months ago
JSON representation

Official ProtonVPN Linux app (CLI)

• Host: GitHub
• URL: https://github.com/ProtonVPN/linux-cli
• Owner: ProtonVPN
• License: gpl-3.0
• Archived: true
• Created: 2021-03-23T15:27:19.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-21T07:13:42.000Z (11 months ago)
• Last Synced: 2024-08-03T05:04:48.933Z (5 months ago)
• Topics: cli, linux, python, vpn
• Language: Python
• Homepage: https://protonvpn.com/download-linux
• Size: 398 KB
• Stars: 333
• Watchers: 28
• Forks: 43
• Open Issues: 61
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING.md

Awesome Lists containing this project

README

        
# Proton VPN Linux CLI

Copyright (c) 2021 Proton Technologies AG

This repository holds the Proton VPN Linux CLI.

For licensing information see [COPYING](COPYING.md).

For contribution policy see [CONTRIBUTING](CONTRIBUTING.md).

## Description

The [Proton VPN](https://protonvpn.com) Linux CLI is intended for every Proton VPN service user.

You can download the latest stable release, either from our official repositories or directly on the [official GitHub repository](https://github.com/ProtonVPN/linux-cli/releases/latest).

### Dependencies:

| **Distro**                              | **Command**                                                                                                     |

|:----------------------------------------|:----------------------------------------------------------------------------------------------------------------|

|Fedora/RHEL                              | `python3-dialog` |

|Ubuntu/Linux Mint/Debian and derivatives | `python3-dialog` |

|Arch Linux/Manjaro                       | `python-pythondialog` |

### Additional dependency:

[Proton VPN NM Library](https://github.com/ProtonVPN/protonvpn-nm-lib)

## Installation

Follow our [knowledge base article](https://protonvpn.com/support/linux-vpn-tool/) on how to install the CLI on your system.

## How to use

| **Command**                           | **Description**                                       |

|:--------------------------------------|:------------------------------------------------------|

|`protonvpn-cli login `  | Login with Proton VPN credentials.                     |

|`protonvpn-cli logout`                 | Logout from Proton VPN.                                |

|`protonvpn-cli connect, c`             | Display connnect dialog in terminal.                  |

|`protonvpn-cli c [servername]`         | Connect to specified server.                          |

|`protonvpn-cli c -r`                   | Connect to random server.                             |

|`protonvpn-cli c -f`                   | Connect to fastest server.                            |

|`protonvpn-cli c --p2p`                | Connect to fastest P2P server.                        |

|`protonvpn-cli c --cc [countrycode]`   | Connect to fastest server in a specified country.     |

|`protonvpn-cli c --sc`                 | Connect to fastest Secure Core server.                |

|`protonvpn-cli disconnect, d`          | Disconnect from VPN session.                          |

|`protonvpn-cli s, status`              | Display VPN session status.                           |

|`protonvpn-cli config`                 | Change user settings.                                 |

|`protonvpn-cli ks, killswitch`         | Change kill switch settings.                          |

|`protonvpn-cli --version`              | Display version.                                      |

|`protonvpn-cli --help`                 | Show help message.                                    |