https://github.com/felixtellmann/deploy-env-custom
https://github.com/felixtellmann/deploy-env-custom
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/felixtellmann/deploy-env-custom
- Owner: FelixTellmann
- License: mit
- Created: 2021-08-04T13:05:54.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-04T13:22:12.000Z (almost 5 years ago)
- Last Synced: 2025-02-01T20:46:13.747Z (over 1 year ago)
- Language: TypeScript
- Size: 107 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# deploy-env
[](https://github.com/Pytal/deploy-env/actions)
[](https://www.npmjs.com/package/deploy-env)
Deploy environment variables from `.env` and `.env-cmdrc.json` files to Vercel.
## Installation
``` bash
npm add -g deploy-env
```
> `deploy-env` expects the Vercel CLI to be installed globally with `npm add -g vercel`
## Usage
In your Vercel project directory:
Make at least one `.env`, `.env.production`, `.env.preview`, or `.env.development` file with your environment variables in the following format:
``` env
API_KEY=top_secret_api_key
TOKEN=some_secret_token
...
```
You can also make a `.env-cmdrc.json` file with the following format:
``` jsonc
{
"development": {
"API_KEY": "development value"
// development environment variables
},
"preview": {
"API_KEY": "preview value"
// preview environment variables
},
"production": {
"API_KEY": "production value"
// production environment variables
}
}
```
Run the command:
``` bash
deploy-env [production | preview | development] [ENV_VAR]...
```
> `dpl-env` can be used as an alias for `deploy-env`
> If a `.env.[environment]` file doesn't exist when running: `deploy-env [environment]`, the `.env` file will be used and deployed to the environment specified in the command
## Examples
Deploy all `preview` environment variables to the Preview deployment
``` bash
deploy-env preview
```
Deploy only the `API_KEY` environment variable to the Preview deployment
``` bash
deploy-env preview API_KEY
```
Deploy only the `API_KEY`, `TOKEN`, and `GRAPHQL_ENDPOINT` environment variables to Production
``` bash
deploy-env production API_KEY TOKEN GRAPHQL_ENDPOINT
```
## Programmatic API
### `deployEnv`
A function which deploys environment variables from `.env` and `.env-cmdrc.json` files:
- `deploymentEnv` { `'production' | 'preview' | 'development'` }: Deployment environment to be deployed to
- `varNameList` { `string[]` }: (optional) List of environment variables to be deployed
- **Returns** { `Promise` }: Promise which resolves when deployment completes
## Related Projects
[`env-cmd`](https://github.com/toddbluhm/env-cmd) - simple node program for executing commands using an environment from an env file
[`dotenv`](https://github.com/motdotla/dotenv) - module that loads environment variables from a `.env` file into [`process.env`](https://nodejs.org/docs/latest/api/process.html#process_process_env)