Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ProtonVPN/protonvpn-cli
Legacy protonvpn-cli: ProtonVPN Command-Line Tool for Linux and macOS. This has been superseded by https://github.com/ProtonVPN/protonvpn-cli-ng
https://github.com/ProtonVPN/protonvpn-cli
linux macos protonvpn protonvpn-cli vpn
Last synced: 3 months ago
JSON representation
Legacy protonvpn-cli: ProtonVPN Command-Line Tool for Linux and macOS. This has been superseded by https://github.com/ProtonVPN/protonvpn-cli-ng
- Host: GitHub
- URL: https://github.com/ProtonVPN/protonvpn-cli
- Owner: ProtonVPN
- License: other
- Archived: true
- Created: 2018-03-08T14:21:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-25T11:10:22.000Z (almost 5 years ago)
- Last Synced: 2024-04-27T20:39:01.915Z (7 months ago)
- Topics: linux, macos, protonvpn, protonvpn-cli, vpn
- Language: Shell
- Homepage:
- Size: 127 KB
- Stars: 602
- Watchers: 47
- Forks: 102
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
README
*protonvpn-cli*
================
# Deprecation warning
This Version of ProtonVPN-CLI has been deprecated and is no longer maintained by the ProtonVPN Team.
It is superseded by Version 2. Due to the new version being written in Python, you can't update it with the `--update` option. The new version needs to be installed manually. For installation instructions, please visit the project page at
https://github.com/ProtonVPN/protonvpn-cli-ng
*Note: To disable the deprecation warning in the program, create a file called `deprecation_warning` in the `~/.protonvpn-cli` configuration folder.*
# Overview #
protonvpn-cli is a command-line tool for Linux and macOS.
# Requirements #
* `openvpn`
* `python`
* `dialog`
* `wget`
* `sysctl`
* `sha512sum`
The program automatically checks for missing requirements.
# Installation #
```bash
$ git clone "https://github.com/protonvpn/protonvpn-cli"
$ cd protonvpn-cli
$ sudo ./protonvpn-cli.sh --install
```
### Or (one-liner): ###
#### (via `git`) ####
```bash
$ sudo bash -c "git clone https://github.com/ProtonVPN/protonvpn-cli.git && ./protonvpn-cli/protonvpn-cli.sh --install"
```
#### (via `wget`) ####
```bash
$ wget "https://github.com/ProtonVPN/protonvpn-cli/raw/master/protonvpn-cli.sh" -O "protonvpn-cli.sh" && sudo bash protonvpn-cli.sh --install
```
# Usage #
| **Command** | **Description** |
| :-------------------------------------------- | :------------------------------------------------------------- |
| `protonvpn-cli --init` | Initialize ProtonVPN profile on the machine. |
| `protonvpn-cli -c, --connect` | Select and connect to a ProtonVPN server. |
| `protonvpn-cli -c [server-name] [protocol]` | Connect to a ProtonVPN server by name. |
| `protonvpn-cli -m, --menu` | Select and connect to a ProtonVPN server from a menu. |
| `protonvpn-cli -r, --random-connect` | Connect to a random ProtonVPN server. |
| `protonvpn-cli -l, --last-connect` | Connect to the previously used ProtonVPN server. |
| `protonvpn-cli -f, --fastest-connect` | Connect to the fastest available ProtonVPN server. |
| `protonvpn-cli -p2p, --p2p-connect` | Connect to the fastest available P2P ProtonVPN server. |
| `protonvpn-cli -tor, --tor-connect` | Connect to the fastest available ProtonVPN TOR server. |
| `protonvpn-cli -sc, --secure-core-connect` | Connect to the fastest available ProtonVPN SecureCore server. |
| `protonvpn-cli -cc, --country-connect` | Select and connect to a ProtonVPN server by country. |
| `protonvpn-cli -cc [country-name] [protocol]` | Connect to the fastest available server in a specific country. |
| `protonvpn-cli -d, --disconnect` | Disconnect the current session. |
| `protonvpn-cli --reconnect` | Reconnect to the current ProtonVPN server. |
| `protonvpn-cli --ip` | Print the current public IP address. |
| `protonvpn-cli --status` | Print connection status. |
| `protonvpn-cli --update` | Update protonvpn-cli. |
| `protonvpn-cli --install` | Install protonvpn-cli. |
| `protonvpn-cli --uninstall` | Uninstall protonvpn-cli. |
| `protonvpn-cli --version` | Display version. |
| `protonvpn-cli --help` | Show help message. |
protonvpn-cli can also be used by typing `pvpn`, once installed.
# Compatibility #
* Linux
* macOS
# License #
protonvpn-cli is released under the MIT license.