UNPKG

vercel-env-create

Version:

<div align="center"> <h1>Vercel Env Create 🛠️</h1> <p>The missing <code>vercel env create</code> command</p> <p> <a href="https://github.com/itsbrex/vercel-env-create" title="Screenshot of vercel-env-create"> <img alt="Screenshot of verce

76 lines (51 loc) 3.51 kB
<div align="center"> <h1>Vercel Env Create 🛠️</h1> <p>The missing <code>vercel env create</code> command</p> <p> <a href="https://github.com/itsbrex/vercel-env-create" title="Screenshot of vercel-env-create"> <img alt="Screenshot of vercel-env-create" src="https://socialify.git.ci/itsbrex/vercel-env-extract/image?description=1&descriptionEditable=Auto-generate%20and%20maintain%20your%20project%27s%20.env%20files&name=1&owner=1&pattern=Solid&stargazers=1&theme=Auto" width="600" /> </a> </p> </div> <div align="center"> <a href="https://github.com/itsbrex/vercel-env-create/actions/workflows/integration.yml"> <img alt="Integration Status" src="https://github.com/itsbrex/vercel-env-create/actions/workflows/integration.yml/badge.svg" /> </a> <a href="https://github.com/itsbrex/vercel-env-create/blob/main/LICENSE"> <img alt="License" src="https://badgen.net/github/license/itsbrex/vercel-env-create" /> </a> <br /> </div> <p> Easily manage your local and Vercel deployment environment variables for `local`, `development`, `preview`, and `production`. `vercel-env-create` is a Node.js script that scans your project for all referenced `process.env` variables and creates separate `.env` files each environment in the root of your project's directory. This makes it easy to manage your local development and test environments, as well as each of your Vercel deployment environments (`development`, `preview`, and `production`). ## Installation You can install this package using `npm`: ```bash npm install -g vercel-env-create ``` ## Usage If you installed globally, you can use it in your project directory like this to either create or update your .env files with all of the variables used in your project: ```bash vercel-env-create ``` Or you can install via `npx`: ```bash npx vercel-env-create ``` By default, the script will look for environment variables in files with the following extensions: `.js`, `.ts`, `.jsx`, `.tsx`, `.html`, and `.css`. You can add additional file extensions to search for by modifying the `extensions` array in the script. The script will create the following .env files in your project directory: - `.env` - for your default environment - `.env.local` - for your local development environment - `.env.development` - for your development environment - `.env.production` - for your production environment This makes it easy to manage separate environment variables for each environment and ensures that all environment variables in your project are appropriately defined. ## Contributing Contributions are welcome! If you find a bug or have a suggestion for improvement, please [open an issue](https://github.com/itsbrex/vercel-env-create/issues) or [submit a pull request](https://github.com/itsbrex/vercel-env-create/pulls). ## Support If you found this project interesting or helpful, please consider [sponsoring me](https://github.com/sponsors/itsbrex) or following me [on twitter](https://twitter.com/itsbrex). <img src="https://storage.googleapis.com/saasify-assets/twitter-logo.svg" alt="twitter" height="24px" align="center"></a> ## License Licensed under the [MIT](https://github.com/itsbrex/vercel-env-create/blob/main/LICENSE) License. ## Thanks Shoutout to [HiDeoo](https://github.com/HiDeoo) for his work on [`vercel-env-push`](https://github.com/HiDeoo/vercel-env-push) and his [`create-app`](https://github.com/HiDeoo/create-app) CLI tool that this project was bootstrapped with. 🙏