Install @vernonthedev/encryptd from GitHub Packages

Set up your .npmrc for the GitHub Packages registry, install encryptd with npm, yarn, or pnpm, and verify the CLI is ready, Node.js 18+ required.

encryptd is published to GitHub Packages under the @vernonthedev scope. Before you can install the package, you must configure your package manager to resolve that scope from the GitHub Packages registry and supply a valid authentication token. This takes two lines in your .npmrc file and a GitHub personal access token.

encryptd ships prebuilt Rust native binaries for all supported platforms. You do not need the Rust toolchain or any C compiler installed on your machine or CI environment.

Prerequisites

• Node.js 18 or later, encryptd relies on the N-API interface that ships with Node.js 18+.

Platform support

Platform	Architecture	Status
macOS	ARM64 (Apple Silicon)	✅ Supported
macOS	x64 (Intel)	✅ Supported
Linux	x64	✅ Supported
Windows	x64	✅ Supported

Install encryptd

1. Configure .npmrc for GitHub Packages

   Create or edit the .npmrc file at the root of your project and add the following two lines:

   .npmrc

   @vernonthedev:registry=https://npm.pkg.github.com
   //npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
   

   The first line tells your package manager to fetch any @vernonthedev/* package from GitHub Packages instead of the public npm registry. The second line provides the authentication token that GitHub Packages requires even for public packages, a token is mandatory to download dependencies.

   Set GITHUB_TOKEN to a GitHub personal access token (classic) with at least the read:packages scope. You can create one at GitHub → Settings → Developer settings → Personal access tokens. In CI environments such as GitHub Actions, the built-in secrets.GITHUB_TOKEN already has read:packages permission and can be used directly without creating a separate token.

2. Install the package

   Run the install command for your package manager of choice:

   npm

   npm install @vernonthedev/encryptd
   

   yarn add @vernonthedev/encryptd
   

   pnpm add @vernonthedev/encryptd
   

   Your package manager downloads the JavaScript bundle and the prebuilt native binary for your current platform automatically. No additional build steps are needed.

3. Verify the installation

   Confirm that the CLI is available by running:

   npx secure-env --help
   

   You should see usage output listing the encrypt and decrypt subcommands. If the command is found and the help text appears, encryptd is installed and ready to use.