Skip to content

Installation

There are two ways to install varlock:

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

If you prefer to let your AI agent install Varlock for you, you can skip these instructions and build a prompt for your agent:

There is also a Docs MCP server that exposes a search tool. See more details here.

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

For AI agent workflows, use non-interactive mode instead:

Terminal window
npx varlock init --agent

To install varlock CLI as a binary, run:

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

Then run the setup wizard to help you get started:

Terminal window
varlock init

Then install the Varlock agent skill:

Terminal window
npx skills add dmno-dev/varlock

See the AI Tools guide for update commands and agent-specific options.