npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@commutatus/cm-env

v1.1.0

Published

Utilities for encrypting and decrypting env files

Downloads

66

Readme

cm-env

Node package to encrypt and decrypt environment files. Each environment uses a different encryption key to maintain security

The inputs and outputs are configurable with the defaults aligned to how .env files are generated for Next.Js

cm-env uses Node's in-built crypto API to handle the encryption/decryption. This allows running cm-env to be used in any environment that can run Node and avoids OS-level issues as frequently happens with other approaches that use openssl


Installation

$ npm install --save cm-env

with yarn:

$ yarn add cm-env

Installing the package locally in the project is recommended to avoid version conflicts between different projects

Inside the package.json add some custom scripts:

{
  "scripts": {
    "encrypt": "cm-env encrypt",
    "decrypt": "cm-env decrypt",
    "setup-encryption-keys": "cm-env setup",
    "cm-env": "cm-env"
  }
}

Usage

Here are some examples on how to use the scripts you added in the Installation section

Create encryption keys

You'll need to create they encryption keys before you can start encrypting files

$ npm run setup-encryption-keys

This will create 3 different .key files. Make sure to never commit these files

Encrypting the env file

  1. Create a file .env.local with the environment variables
  2. Create the encrypted file by running npm run encrypt -- [env name]

Replace [env name] with the environment name, for example:

$ npm run encrypt -- staging

# or

$ npm run encrypt -- dev

# or

$ npm run encrypt -- prod

Custom environment names are supported

This will create a file under keys/[env name].enc which is the encrypted version of .env.local

Decrypting the env file

Run this command to decrypt the .enc file for a particular environment:

$ npm run decrypt -- [env name]

This will replace the .env.local file with the contents of the file that was decrypted

Getting help

The package takes additional arguments which can be used to customize it's behavior to better fit your needs. Check out the help menu by using this command: $ npm run cm-env -- help