Skip to content

Installation

There are two ways to install varlock:

  1. Install as a dependency in JavaScript/TypeScript projects
  2. Install as a standalone binary

Requires:

  • Node.js version 22 or higher

To install varlock in your project, run:

Terminal window
npx varlock init

This will install varlock as a dependency and scan your project for .env files and create a .env.schema file in the root of your project. Depending on your project configuration, it will optionally:

  • Remove your existing .env.example file
  • Add decorators to your .env.schema file to specify the type of each environment variable
  • Encrypt secrets in your .env file

To install varlock CLI as a binary, run:

Terminal window
# Install via homebrew
brew install dmno-dev/tap/varlock
# OR Install via cURL
curl -sSfL https://varlock.dev/install.sh | sh -s

After installation, you can run varlock --help to see the available commands or read the CLI Reference.