{"id":15015676,"url":"https://github.com/jcemerson/protonvpn-cli-gui","last_synced_at":"2025-04-12T09:43:10.181Z","repository":{"id":52451577,"uuid":"245716975","full_name":"jcemerson/protonvpn-cli-gui","owner":"jcemerson","description":"Kivy-based ProtonVPN GUI for protonvpn-cli-ng on Linux (Unofficial)","archived":false,"fork":false,"pushed_at":"2021-04-28T22:17:05.000Z","size":2841,"stargazers_count":11,"open_issues_count":4,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-29T04:04:49.026Z","etag":null,"topics":["kivy","linux","protonvpn","protonvpn-cli-ng","python3"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jcemerson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-07T22:47:29.000Z","updated_at":"2022-07-09T17:05:35.000Z","dependencies_parsed_at":"2022-08-19T20:31:34.035Z","dependency_job_id":null,"html_url":"https://github.com/jcemerson/protonvpn-cli-gui","commit_stats":null,"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcemerson%2Fprotonvpn-cli-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcemerson%2Fprotonvpn-cli-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcemerson%2Fprotonvpn-cli-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcemerson%2Fprotonvpn-cli-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcemerson","download_url":"https://codeload.github.com/jcemerson/protonvpn-cli-gui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248549807,"owners_count":21122925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kivy","linux","protonvpn","protonvpn-cli-ng","python3"],"created_at":"2024-09-24T19:47:46.379Z","updated_at":"2025-04-12T09:43:10.153Z","avatar_url":"https://github.com/jcemerson.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eProtonVPN-CLI-GUI\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/jcemerson/protonvpn-cli-gui/blob/master/protonvpn_cli_gui/images/protonvpn-wallpaper-7.jpg\" alt=\"ProtonVPN\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/v/release/jcemerson/protonvpn-cli-gui?include_prereleases\u0026style=flat-square\" alt=\"GitHub Downloads\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://pepy.tech/project/protonvpn-cli-gui\"\u003e\n      \u003cimg alt=\"Downloads per Week\" src=\"https://pepy.tech/badge/protonvpn-cli-gui\"\u003e\n    \u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/pypi/dm/protonvpn-cli-gui?style=flat-square\" alt=\"PyPi Downloads\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/pypi/pyversions/protonvpn-cli-gui?style=flat-square\" alt=\"Python Versions\"\u003e\u003c/img\u003e\n  \u003cimg src=\"https://img.shields.io/pypi/wheel/protonvpn-cli-gui?style=flat-square\" alt=\"Wheel\"\u003e\u003c/img\u003e\n  \u003cimg src=\"https://img.shields.io/pypi/l/protonvpn-cli-gui?style=flat-square\" alt=\"License\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eA GUI for \u003ca href=\"https://github.com/ProtonVPN/protonvpn-cli-ng\"\u003e\u003cb\u003eProtonVPN-CLI\u003c/b\u003e\u003c/a\u003e on Linux (Unofficial), written entirely in Python.\u003c/h3\u003e\n\nProtonVPN-CLI-GUI is \u003ca href=\"https://github.com/kivy/kivy\"\u003e\u003cb\u003eKivy\u003c/b\u003e\u003c/a\u003e-based GUI built on top of \u003ca href=\"https://github.com/ProtonVPN/protonvpn-cli-ng\"\u003e\u003cb\u003eprotonvpn-cli-ng\u003c/b\u003e\u003c/a\u003e as the back-end. Wherever possible, the GUI relies on the actual code of the CLI, so ProtonVPN-CLI-GUI will remain up to date with \u003ca href=\"https://github.com/ProtonVPN/protonvpn-cli-ng\"\u003e\u003cb\u003eProtonVPN-CLI\u003c/b\u003e\u003c/a\u003e.\n\n\n\n### Installing Dependencies\n\n**Dependencies:**\n\n- \u003ca href=\"https://github.com/kivy/kivy\"\u003e\u003cb\u003eKivy\u003c/b\u003e\u003c/a\u003e\n- \u003ca href=\"https://github.com/OpenVPN/openvpn\"\u003e\u003cb\u003eOpenVPN\u003c/b\u003e\u003c/a\u003e\n- \u003ca href=\"https://github.com/pypa/pip\"\u003e\u003cb\u003epip for Python3 (pip3)\u003c/b\u003e\u003c/a\u003e\n- \u003ca href=\"https://github.com/ProtonVPN/protonvpn-cli-ng\"\u003e\u003cb\u003eProtonVPN-CLI\u003c/b\u003e\u003c/a\u003e\n- \u003ca href=\"https://www.python.org/\"\u003e\u003cb\u003ePython3.6+\u003c/b\u003e\u003c/a\u003e\n- \u003ca href=\"https://pypi.org/project/setuptools/\"\u003e\u003cb\u003esetuptools for python3 (python3-setuptools)\u003c/b\u003e\u003c/a\u003e\n\nTo install \u003ca href=\"https://github.com/ProtonVPN/protonvpn-cli-ng\"\u003e\u003cb\u003eProtonVPN-CLI\u003c/b\u003e\u003c/a\u003e, depending on your distribution, run the appropriate following command to install the necessary dependencies.\nFor more detailed information on installing, updating and uninstalling, please view the extensive [usage guide](https://github.com/ProtonVPN/protonvpn-cli-ng/blob/master/USAGE.md#installation--updating):\n\n| **Distro**                              | **Command**                                                        |\n|:----------------------------------------|:------------------------------------------------                   |\n|Fedora/CentOS/RHEL                       | `sudo dnf install -y openvpn dialog python3-pip python3-setuptools`|\n|Ubuntu/Linux Mint/Debian and derivatives | `sudo apt install -y openvpn dialog python3-pip python3-setuptools`|\n|OpenSUSE/SLES                            | `sudo zypper in -y openvpn dialog python3-pip python3-setuptools`  |\n|Arch Linux/Manjaro                       | `sudo pacman -S openvpn dialog python-pip python-setuptools`       |\n\n\n**Installing ProtonVPN-CLI**\n\n`sudo pip3 install protonvpn-cli`\n\n\nOnce you've installed \u003ca href=\"https://github.com/ProtonVPN/protonvpn-cli-ng\"\u003e\u003cb\u003eprotonvpn-cli-ng\u003c/b\u003e\u003c/a\u003e, install \u003cb\u003eProtonVPN-CLI-GUI\u003c/b\u003e.\n\n*Note: This has only been tested on Linux Mint 19.3 Cinnamon.*\n\n\n## Installing ProtonVPN-CLI-GUI\n\n**Kivy Dependencies**\n\nPrior to installing the GUI, run the following command to ensure the necessary Kivy dependencies are in place.\n\n`sudo apt install -y build-essential git python3-dev ffmpeg libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev libportmidi-dev libswscale-dev libavformat-dev libavcodec-dev zlib1g-dev xclip`\n\n\nFor installing the GUI, you can either install via \u003cb\u003ePIP\u003c/b\u003e (simple) or by cloning this repository (must manually manage dependencies, etc).\n\n*Note: Make sure to run pip with sudo*\n\n`sudo pip3 install protonvpn-cli-gui`\n\n\n\n### To update to a new version\n\n`sudo pip3 install protonvpn-cli-gui --upgrade`\n\n\n\n## Manual Installation\n\n1. Clone this repository:\n\n    `git clone https://github.com/jcemerson/protonvpn-cli-gui`\n\n2. Navigate to the directory:\n\n   `cd {/path/to/directory/}protonvpn-cli-gui`\n\n3. Install:\n\n    `sudo python3 setup.py install`\n\n\n\n### How to use\n\n `sudo protonvpn-cli-gui`\n\n\n### Recommendation for Convenience:\nFor passwordless execution without using a terminal, such as by automated script or .desktop file, \u003ca href=\"https://www.linux.com/training-tutorials/configuring-linux-sudoers-file/\"\u003e\u003cb\u003eupdate your sudoers file\u003c/b\u003e\u003c/a\u003e by using `sudo visudo` and paste the following at the bottom (last line) of your file:\n\n`{your_linux_username} ALL = (root) NOPASSWD: /usr/local/bin/protonvpn-cli-gui`\n\n*Note: The path to your bin might be different. To find, use* `which protonvpn-cli-gui`\n\n\n\n## Create .desktop file\n\nTo create a desktop application launcher using a .desktop file:\n\n1. Create a new file in `.local/share/applications/` named `protonvpn-cli-gui.desktop` with the following contents:\n\n    ```\n    [Desktop Entry]\n    Name=ProtonVPN-CLI-GUI\n    GenericName=ProtonVPN-CLI-GUI\n    Exec=sudo protonvpn-cli-gui\n    Icon={path/to/icon}\n    Type=Application\n    Terminal=False\n    Categories=Network;VPN\n    ```\n    *Note: Be sure to update the Icon with your own path to an image file.*\n\n\n\n### This is a pre-release and not all planned features have been implemented.\n\nSome remaining features include:\n\n- Logging (GUI-only. Kivy, OpenVPN, and ProtonVPN-CLI all have logs of their own.)\n- Searchable Server List\n- Start on Boot\n- Connection Profiles (user-configurable connection profiles that can be saved, e.g. \"Fastest TOR server with TCP connection\", \"Fastest P2P server in Iceland\", etc.).\n- Built-in Connection Speed Test\n- System Tray icon with connection status notification\n\n\n\n## Screenshots\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/jcemerson/protonvpn-cli-gui/blob/master/protonvpn_cli_gui/images/Screenshot%20from%202020-03-22%2020-25-10.png\" alt=\"Main Screen\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/jcemerson/protonvpn-cli-gui/blob/master/protonvpn_cli_gui/images/Screenshot%20from%202020-03-22%2020-27-33.png\" alt=\"Secure Core Notification\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/jcemerson/protonvpn-cli-gui/blob/master/protonvpn_cli_gui/images/Screenshot%20from%202020-03-22%2020-27-52.png\" alt=\"Disconnected\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/jcemerson/protonvpn-cli-gui/blob/master/protonvpn_cli_gui/images/Screenshot%20from%202020-03-22%2020-28-47.png\" alt=\"Secure Core\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/jcemerson/protonvpn-cli-gui/blob/master/protonvpn_cli_gui/images/Screenshot%20from%202020-03-22%2020-29-27.png\" alt=\"Menu\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/jcemerson/protonvpn-cli-gui/blob/master/protonvpn_cli_gui/images/Screenshot%20from%202020-03-22%2020-30-00.png\" alt=\"VPN Settings\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcemerson%2Fprotonvpn-cli-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcemerson%2Fprotonvpn-cli-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcemerson%2Fprotonvpn-cli-gui/lists"}