Documentation

Complete setup guide for all platforms

1. Install Node.js

VaultX requires Node.js 16 or higher.

winget install OpenJS.NodeJS

Or download from nodejs.org

2. Install VaultX

npm install -g @vaultx-official/vaultx

3. Verify Installation

vx --version

4. Environment Variables (Optional)

NPM automatically adds VaultX to your PATH. If needed, manually add:

%APPDATA%\npm

Add this to System Environment Variables → Path

5. SSH Setup (Optional)

VaultX includes a complete SSH client with identity management:

Generate SSH identity:

vx ssh init my-server

Configure server connection:

vx ssh add my-server user@192.168.1.100

Connect to server:

vx ssh connect my-server

Transfer files with SCP:

vx scp my-server local.txt remote:/path/to/file.txt

Quick Start

Secrets Management

Initialize a project:

vx init my-project

Add a secret:

vx add my-project API_KEY

Retrieve a secret:

vx get my-project API_KEY

List all vault contents:

vx list

SSH Management

Generate SSH identity:

vx ssh init production

Configure server:

vx ssh add production ubuntu@prod.example.com

Connect to server:

vx ssh connect production

Transfer files:

vx scp production deploy.zip remote:/var/www/app/

Maintenance

Run security audit:

vx audit

Update VaultX:

vx update