Getting Started
Vaultlier helps you securely manage secrets, API keys, and sensitive configuration across your projects and environments.
Overview
Vaultlier is a sealed, centrally hosted configuration vault. It replaces the .env workflow without ever writing secret values to disk: your code declares which keys it needs, the portal stores the encrypted values, and the runtime SDK resolves them in memory at startup.
You work with Vaultlier through three surfaces:
- The CLI — set up a project, sync schema metadata, write secret values, and inspect configuration locally.
- The SDK — a tiny, edge-safe runtime client that fetches typed configuration for one environment.
- The portal — the web dashboard where projects, environments, API keys, and members live.
Secrets never touch disk
Vaultlier keeps your secrets in memory and never writes them to disk, logs, or environment files. The artifacts the CLI generates (vaultlier.json and lib/vaultlier.ts) contain metadata only — key names, types, and scopes.Install
Install the Vaultlier package to get the CLI and the runtime SDK.
# Using npm
npm install vaultlier
# Or run the CLI ad-hoc with npx
npx vaultlier --helpInitialize
Run init in your project directory. It installs the dependency if needed, walks you through logging in and selecting (or creating) a project, and writes the schema and the generated typed client.
vaultlier init # creates vaultlier.json + lib/vaultlier.tsPressing Enter at the API-key prompt is fine — a brand-new account has no key yet, and you can add one later with vaultlier config set apiKey=… or the VAULTLIER_API_KEY environment variable.
Use in code
Import the generated client and resolve configuration for an environment. Every key is fully typed from your schema.
import { vault } from "./lib/vaultlier";
const config = await vault({ environment: "prod" });
config.DATABASE_URL; // string
config.STRIPE_SECRET; // string
config.FEATURE_NEW_FLOW; // booleanNext steps
- Follow the Quickstart for an end-to-end walkthrough.
- Skim the CLI reference for every command and flag.
- Read Security to understand the trust boundaries.