Installation

Install Vaulted from prebuilt binaries, or build from source with Bun and a Rust toolchain.

Installer script

curl -fsSL https://raw.githubusercontent.com/woosal1337/vaulted/main/scripts/install.sh | sh

The script picks the tarball for your platform from the latest GitHub release, verifies its SHA-256 checksum, and installs to ~/.local/bin. Make sure that directory is on your PATH.

Manual download

Download vaulted-<tag>-<platform>-<arch>.tar.gz and SHA256SUMS from the releases page, verify the checksum, and extract the tarball into a directory on your PATH.

curl -fsSLO https://github.com/woosal1337/vaulted/releases/download/v0.3.0/vaulted-v0.3.0-darwin-arm64.tar.gz
curl -fsSLO https://github.com/woosal1337/vaulted/releases/download/v0.3.0/SHA256SUMS
shasum -a 256 --check --ignore-missing SHA256SUMS
tar -xzf vaulted-v0.3.0-darwin-arm64.tar.gz -C ~/.local/bin

On Linux, replace shasum -a 256 --check with sha256sum --check. Each tarball contains the standalone vaulted binary and the Rust runner library in prebuilds/<platform>-<arch>/. Keep them side by side, the binary looks for the runner in a prebuilds directory next to itself.

From source

Building from source requires Bun and a Rust toolchain with cargo.

git clone https://github.com/woosal1337/vaulted
cd vaulted
bun install
bun run build:runner
bun run --cwd apps/cli build

bun run build:runner runs cargo build --release for packages/runner, and the CLI build compiles a standalone binary to apps/cli/dist/vaulted. You can also skip the CLI build and run straight from source with bun apps/cli/src/index.ts.

Platform support

Target	Platform	Status
darwin-arm64	macOS on Apple silicon	Supported
darwin-x64	macOS on Intel	Supported
linux-x64	Linux on x64	Supported
linux-arm64	Linux on arm64	Supported
windows	Windows	Out of scope for v0.3

What lands on disk

Path	Purpose	Mode
~/.local/bin/vaulted	The standalone CLI binary, placed by the installer	default
~/.local/bin/prebuilds/<platform>-<arch>/	The Rust runner library, loaded from next to the binary	default
~/.config/vaulted/vaulted.db	The SQLite vault, created by vaulted init, values are ciphertext	0600
~/.config/vaulted/password	Master password fallback, only written when no OS keychain is available	0600
<project>/vaulted.toml	Project id and default environment for the directory, no secret material	default

The database runs in WAL mode and its companion files inherit the 0600 mode. Set VAULTED_CONFIG_DIR to move the config directory away from ~/.config/vaulted.

PreviousIntroduction

NextQuickstart