README.md
1*protonvpn-cli*
2================
3
4
5
6# Overview #
7protonvpn-cli is a command-line tool for Linux and macOS.
8
9# Requirements #
10
11* `openvpn`
12* `python`
13* `dialog`
14* `wget`
15* `sysctl`
16* `sha512sum`
17
18The program automatically checks for missing requirements.
19
20
21# Installation #
22
23```bash
24$ git clone "https://github.com/protonvpn/protonvpn-cli"
25$ cd protonvpn-cli
26$ sudo ./protonvpn-cli.sh --install
27```
28
29### Or (one-liner): ###
30
31#### (via `git`) ####
32
33```bash
34$ sudo bash -c "git clone https://github.com/ProtonVPN/protonvpn-cli.git && ./protonvpn-cli/protonvpn-cli.sh --install"
35```
36#### (via `wget`) ####
37```bash
38$ wget "https://github.com/ProtonVPN/protonvpn-cli/raw/master/protonvpn-cli.sh" -O "protonvpn-cli.sh" && sudo bash protonvpn-cli.sh --install
39```
40
41
42# Usage #
43
44| **Command** | **Description** |
45| :-------------------------------------------- | :------------------------------------------------------------- |
46| `protonvpn-cli --init` | Initialize ProtonVPN profile on the machine. |
47| `protonvpn-cli -c, --connect` | Select and connect to a ProtonVPN server. |
48| `protonvpn-cli -c [server-name] [protocol]` | Connect to a ProtonVPN server by name. |
49| `protonvpn-cli -m, --menu` | Select and connect to a ProtonVPN server from a menu. |
50| `protonvpn-cli -r, --random-connect` | Connect to a random ProtonVPN server. |
51| `protonvpn-cli -l, --last-connect` | Connect to the previously used ProtonVPN server. |
52| `protonvpn-cli -f, --fastest-connect` | Connect to the fastest available ProtonVPN server. |
53| `protonvpn-cli -p2p, --p2p-connect` | Connect to the fastest available P2P ProtonVPN server. |
54| `protonvpn-cli -tor, --tor-connect` | Connect to the fastest available ProtonVPN TOR server. |
55| `protonvpn-cli -sc, --secure-core-connect` | Connect to the fastest available ProtonVPN SecureCore server. |
56| `protonvpn-cli -cc, --country-connect` | Select and connect to a ProtonVPN server by country. |
57| `protonvpn-cli -cc [country-name] [protocol]` | Connect to the fastest available server in a specific country. |
58| `protonvpn-cli -d, --disconnect` | Disconnect the current session. |
59| `protonvpn-cli --reconnect` | Reconnect to the current ProtonVPN server. |
60| `protonvpn-cli --ip` | Print the current public IP address. |
61| `protonvpn-cli --status` | Print connection status. |
62| `protonvpn-cli --update` | Update protonvpn-cli. |
63| `protonvpn-cli --install` | Install protonvpn-cli. |
64| `protonvpn-cli --uninstall` | Uninstall protonvpn-cli. |
65| `protonvpn-cli --version` | Display version. |
66| `protonvpn-cli --help` | Show help message. |
67
68
69protonvpn-cli can also be used by typing `pvpn`, once installed.
70
71
72# Compatibility #
73* Linux
74* macOS
75
76# License #
77
78protonvpn-cli is released under the MIT license.
79
){kind=link}