Nautilus: Pelagic Mollusc

    pritunlctl

    1.3.1 • Public • Published

    Unofficial CLI for Pritunl

    With support for starting & stopping a VPN connection managed by the Pritunl app.

    Getting Started

    Requirements

    You must have the Pritunl app installed with an ovpn profile configured. See caveats below.

    Install as CLI

    yarn global add pritunlctl

    OR

    npm install --global pritunlctl

    Usage

    Usage: pritunlctl <command>
    
    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

    Keywords

    none

    Install

    npm i pritunlctl

    DownloadsWeekly Downloads

    1

    Version

    1.3.1

    License

    MIT

    Unpacked Size

    46.8 kB

    Total Files

    49

    Last publish

    Collaborators

    • sterlingwes