https://github.com/sterlingwes/pritunlctl
CLI tool for controlling a VPN connection managed by Pritunl
https://github.com/sterlingwes/pritunlctl
pritunl
Last synced: about 2 months ago
JSON representation
CLI tool for controlling a VPN connection managed by Pritunl
- Host: GitHub
- URL: https://github.com/sterlingwes/pritunlctl
- Owner: sterlingwes
- License: mit
- Created: 2019-12-01T05:09:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T10:44:22.000Z (over 2 years ago)
- Last Synced: 2025-03-15T05:16:29.771Z (3 months ago)
- Topics: pritunl
- Language: TypeScript
- Size: 129 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Deprecated :warning:
pritunl-client now has its own CLI: https://docs.pritunl.com/docs/command-line-interface
pritunlctl will only work for older versions of the pritunl GUI, see below under Caveats.
---
# Unofficial CLI for Pritunl
With support for starting & stopping a VPN connection managed by [the Pritunl app](https://client.pritunl.com/).
## Getting Started
### Requirements
You must have [the Pritunl app](https://client.pritunl.com/) installed with an ovpn profile configured. See caveats below.
### Install as CLI
`yarn global add pritunlctl`
OR
`npm install --global pritunlctl`
## Usage
```
Usage: pritunlctl
commands:
- start
- auto
- stop
- config
- help
```
`start` will prompt you for your OTP code, unless you use `config` to set your Pritunl OTP token on your keychain for auto-generated codes.
`auto` will attempt to connect without an OTP code or password provided your profile supports it.
## Caveats
* Does not support all connection methods (just OTP with `start` and push 2FA with `auto`)
* It assumes you have the Pritunl GUI app installed with a profile already configured.
* This software relies on the filesystem set by the Pritunl app which may be subject to change in future versions.
Verified compatible with these Pritunl client versions:
* `v1.0.2440.93`
* `v1.0.2226.23`
* `v1.0.1953.32`
Verified incompatible:
* `v1.2.2897.44`