▮Docs
Documentation

Install

Install vestauth where you need it.

curl -sfS https://vestauth.sh | sh

Npm

vestauth is made with javascript.

npm install vestauth --save

// index.js
require('vestauth').verify()

Find the vestauth package here.

Shell

Install with curl via our install.sh script.

curl -sfS https://vestauth.sh | sh

Or with wget:

wget -qO- https://vestauth.sh | sh

Read the install.sh script here.

GitHub Releases

You can also download straight from GitHub Releases.

curl -L -o vestauth.tar.gz "https://github.com/vestauth/vestauth/releases/latest/download/vestauth-$(uname -s)-$(uname -m).tar.gz"
tar -xzf vestauth.tar.gz
./vestauth help

If you download manually you'll need to move the binary somewhere in your PATH.

Windows

Download the windows executable directly from the releases page.

(unzip to extract vestauth.exe)

Standalone

vestauth is a standalone binary, so (if you want) you can just download it directly:

# download it to `./vestauth`
curl -sfS --proto '=https' https://vestauth.sh/$(uname)/$(uname -m).tgz | tar xz

# install it to `/usr/local/bin/vestauth`
sudo install -m 755 vestauth /usr/local/bin

# check it works
vestauth help

Download a specific version:

# download version 0.7.0
curl -sfS --proto '=https' "https://vestauth.sh/$(uname)/$(uname -m).tgz?version=v0.7.0" | tar xz

# check the version
./vestauth --version

You can view available versions at github.com/vestauth/releases

Npm local

Use vestauth locally as a cli in your node project.

npm i vestauth --save

{
  "scripts": {
    "curl": "./node_modules/.bin/vestauth agent curl"
  },
  "dependencies": {
    "vestauth": "^0.7.0"
  }
}

Npm global

You can also install globally using npm's --global or -g flag.

npm i -g vestauth
vestauth help

Npx

Or prefer to run as needed, uses npx.

npx vestauth help

pkgx

pkgx is a single, standalone binary that can run anything. Since it can run anything, it can run vestauth:

pkgx npx vestauth help