Installation

Install Vestauth via npm, curl, GitHub releases, or Windows executable

npm (Recommended)

Install Vestauth globally using npm:

npm i -g vestauth

This installs the vestauth CLI and makes it available system-wide.

Version: The latest version is published to npmjs.com/package/vestauth

Check your installed version: vestauth --version

Local Installation

For project-specific installations:

npm install vestauth

Then use it programmatically:

const vestauth = require('vestauth')

// Initialize an agent
const result = await vestauth.agent.init()
console.log(result.AGENT_UID)

curl Install Script

Install Vestauth with a single curl command:

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

This downloads and installs the latest binary for your platform.

1. Run the install script

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

   The script automatically detects your OS and architecture.

2. Verify installation

   vestauth --version
   

   You should see the installed version number.

3. Initialize an agent

   vestauth agent init
   

   This creates your first agent identity.

The curl installer adds Vestauth to your PATH automatically. You may need to restart your shell.

GitHub Releases

Download pre-built binaries directly from GitHub releases:

macOS / Linux

Auto-detect

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 agent init

This automatically downloads the correct binary for your system.

Manual Download

Available binaries:

• macOS Intel: vestauth-Darwin-x86_64.tar.gz
• macOS Apple Silicon: vestauth-Darwin-arm64.tar.gz
• Linux x64: vestauth-Linux-x86_64.tar.gz
• Linux ARM64: vestauth-Linux-arm64.tar.gz

Download from github.com/vestauth/vestauth/releases

Windows

Download the Windows executable from the releases page:

1. Download the executable

   Choose your architecture:

   • vestauth-windows-amd64.zip
   • vestauth-windows-x86_64.zip

   Most modern Windows systems use amd64 (64-bit).

2. Extract the ZIP file

   Unzip the downloaded file to extract vestauth.exe.

3. Add to PATH (optional)

   Move vestauth.exe to a directory in your PATH, or add its location to your PATH environment variable.

   Alternatively, run it directly:

   .\vestauth.exe agent init
   
4. Initialize an agent

   vestauth agent init
   

   This creates your agent identity in .env.

Windows Defender may flag the executable. This is a false positive common with unsigned executables. You can safely allow it.

Verify Installation

After installing via any method, verify Vestauth is working:

Check Version

vestauth --version
# vestauth/0.22.1 linux-x64 node-v20.x.x

Platform Support

Vestauth is tested and supported on:

Platform	Architecture	Status
macOS	Intel (x86_64)	✅ Supported
macOS	Apple Silicon (arm64)	✅ Supported
Linux	x86_64	✅ Supported
Linux	ARM64	✅ Supported
Windows	amd64	✅ Supported
Windows	x86_64	✅ Supported

Installation Stats

npm Downloads

View on npmjs.com

GitHub Releases

View releases

Troubleshooting

Command not found after npm install

If vestauth is not found after npm installation:

1. Check if global npm bin is in your PATH:

   npm config get prefix
   

2. Add npm global bin to PATH:

   export PATH="$(npm config get prefix)/bin:$PATH"
   

3. Or use npx:

   npx vestauth agent init
   

Permission denied on Linux/macOS

If you get permission errors when installing globally:

1. Use sudo (not recommended):

   sudo npm i -g vestauth
   

2. Or configure npm to use a different directory:

   mkdir ~/.npm-global
   npm config set prefix '~/.npm-global'
   export PATH=~/.npm-global/bin:$PATH
   npm i -g vestauth
   

Windows executable blocked by antivirus

Windows Defender may flag vestauth.exe as potentially harmful:

1. This is a false positive due to the executable being unsigned
2. Click “More info” → “Run anyway” to allow it
3. Alternatively, add an exception in Windows Defender

The source code is open and can be verified at github.com/vestauth/vestauth

curl install fails

If the curl install script fails:

1. Check your internet connection
2. Verify curl is installed: curl --version
3. Try downloading manually from GitHub releases
4. Check for proxy or firewall issues

You can also inspect the install script:

curl -sfS https://vestauth.sh

Updating Vestauth

Keep Vestauth up to date:

npm

npm update -g vestauth

Next Steps

Now that Vestauth is installed:

Quickstart Guide

Create your first agent and make authenticated requests

CLI Reference

Learn all available Vestauth commands

Use as a Library

Integrate Vestauth into your code

Build Tools

Create authenticated APIs for agents