aboutsummarylogtreecommitdiffstats
path: root/README.md
blob: 6ab127e4dbf8b893ad4b40c0e0792c4d67b8f7b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# Windscribe VPN CLI for Arch Linux

**Update: You can install this package from [AUR](https://aur.archlinux.org/packages/windscribe-cli/)**

## Circle CI Build Status

[![CircleCI](https://circleci.com/gh/hkuchampudi/Windscribe/tree/master.svg?style=svg)](https://circleci.com/gh/hkuchampudi/Windscribe/tree/master)

## Overview

This repository contains the files necessary to build Windscribe VPN CLI for Arch Linux. Currently, Windscribe's CLI is in open beta, so users 
should anticipate breakages.

## Installation

### Installing From AUR

- You install this package from the Arch User Repository (AUR) by using the AUR helper of your choice (e.g. `yay -S windscribe-cli`).

### Installation

In order the install Windscribe's CLI from this repository, use the following instructions:

1. Clone this repository onto your local machine.
2. `cd` into the cloned repository.
3. Execute `makepkg -cs` to build the package.
4. After the build process is finished, run `sudo pacman -U windscribe-cli-*.pkg.tar` to install the package.

## Running Windscribe CLI

1. After installing for the first time, close out of any active terminals (this is so that bash autocomplete works)
2. Check to see if the windscribe daemon is running: `systemctl status windscribe.service`
3. If the daemon is not running, you can simply run `sudo systemctl start windscribe`. (If you want the daemon to automatically start on boot, 
you can run `sudo systemctl enable windscribe`, otherwise you will have to execute `sudo systemctl start windscribe` every time the computer is 
booted)
4. Now running `windscribe` in your terminal should bring-up the CLI
5. To login to windscribe, run `windscribe login`
6. To connect to windscribe, run `windscribe connect`
7. If you need additional help, run `windscribe --help`

![Terminal](images/ready.png)

## Resources

[Windscribe](https://windscribe.com/)

[Windscribe Linux Download](https://windscribe.com/guides/linux)