Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hideoo/vercel-env-push
The missing Vercel CLI command to push environment variables from .env files.
https://github.com/hideoo/vercel-env-push
cli env env-file environment-variables push vercel
Last synced: about 1 month ago
JSON representation
The missing Vercel CLI command to push environment variables from .env files.
- Host: GitHub
- URL: https://github.com/hideoo/vercel-env-push
- Owner: HiDeoo
- License: mit
- Created: 2022-06-29T14:18:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-26T18:41:25.000Z (over 1 year ago)
- Last Synced: 2024-11-02T08:22:26.186Z (about 2 months ago)
- Topics: cli, env, env-file, environment-variables, push, vercel
- Language: TypeScript
- Homepage:
- Size: 175 KB
- Stars: 13
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
vercel-env-push 🔏
The missing vercel env push command
## Motivations
The [Vercel command-line interface (CLI)](https://vercel.com/docs/cli) provides a `vercel env pull [file]` command that can be used to pull development environment variables from a Vercel project and write them to a .env file. Unfortunately, the reverse operation is not doable through the Vercel CLI.
As I couldn't find any other tools providing this functionality with the features I wanted, I decided to write my own which internally uses [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) to run the Vercel CLI either installed locally or fetched remotely.
> **Note**
> On November 17th 2022, Vercel [released](https://vercel.com/changelog/bulk-upload-now-available-for-environment-variables) bulk upload for environment variables altho this feature is only available through the Vercel Dashboard UI which is an improvement but still not ideal.
## Features
- Usable as a command-line tool or through an API
- Push to multiple environments at once
- Ability to add/remove/edit environment variables before pushing
- Support for [authorization tokens](https://vercel.com/docs/cli#introduction/global-options/token)
- Dry-run mode
## Usage
### CLI
You can either add `vercel-env-push` to your project and invoke it with your favorite package manager (or through an entry in your project's `package.json` file):
```shell
$ pnpm add -D vercel-env-push
$ pnpm vercel-env-push [...otherEnvs]
```
or use it directly with `npx`:
```shell
$ npx vercel-env-push [...otherEnvs]
```
The `file` argument is the path to the .env file containing the environment variables to push. The `env` argument is the name of the environment to push the environment variables to (the supported environments are `development`, `preview` and `production`). You can specify multiple environments by separating them with spaces.
> **Warning**
> Due to the way the Vercel CLI works, if you have pre-existing environment variables associated to multiple environments (e.g. created through the Vercel Dashboard UI), running `vercel-env-push` to push environment variables to a single environment will remove the environment variables associated to the other environments. Note that environment variables pushed to multiple environments with `vercel-env-push` do not have this limitation as `vercel-env-push` will create a new environment variable for each environment instead of a single one shared across multiple environments.
#### Usage
```shell
# Push the environment variables from the .env.local file to the preview & production environments.
$ pnpm vercel-env-push .env.local preview production
```
#### Options
The following options are available through the CLI:
##### `--dry, --dry-run`
List environment variables without pushing them.
```shell
$ pnpm vercel-env-push .env.local development --dry
```
##### `-t, --token`
Login token to use for pushing environment variables.
```shell
$ VERCEL_ORG_ID= VERCEL_PROJECT_ID= pnpm vercel-env-push .env.local development -t
```
This can be especially useful if you ever need to push environment variables [from a CI pipeline](https://vercel.com/support/articles/using-vercel-cli-for-custom-workflows).
```yaml
- name: Push environment variables from GitHub Actions
run: pnpm vercel-env-push .env.local preview -t "$VERCEL_TOKEN"
env:
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
```
##### `-b, --branch`
The Git branch to apply the environment variables to when pushing environment variables to the Preview environment.
```shell
$ pnpm vercel-env-push .env.local preview --branch my-preview-branch
```
### API
`vercel-env-push` can also be used through an API:
```ts
pushEnvVars(envFilePath: string, envs: string[], options?: Options): Promise
```
#### Usage
```ts
import { pushEnvVars } from 'vercel-env-push'
// Push the environment variables from the .env.local file to the preview & production environments.
await pushEnvVars('.env.local', ['preview', 'production'])
```
#### Options
##### `token`
Determines a [login token](https://vercel.com/docs/cli#introduction/global-options/token) to use for pushing environment variables.
```ts
import { pushEnvVars } from 'vercel-env-push'
await pushEnvVars('.env.local', ['preview', 'production'], {
token: process.env.VERCEL_TOKEN,
})
```
##### `branch`
Determines a Git branch to apply the environment variables to when pushing environment variables to the Preview environment.
```ts
import { pushEnvVars } from 'vercel-env-push'
await pushEnvVars('.env.local', ['preview'], {
branch: process.env.GIT_BRANCH,
})
```
##### `prePush`
Specifies a callback that can be used to add/remove/edit environment variables before pushing.
```ts
import { pushEnvVars } from 'vercel-env-push'
await pushEnvVars('.env.local', ['preview', 'production'], {
prePush: async ({ keyToRemove, ...otherEnvVars }) => {
const secretValue = await getSecretValueFromVault()
return {
...otherEnvVars,
newKey: 'newValue',
existingKey: 'updatedValue',
secret: secretValue,
}
},
})
```
> **Note**
> The `dryRun` & `interactive` options are also available through the API but are mostly useless in this context.
## License
Licensed under the MIT License, Copyright © HiDeoo.
See [LICENSE](https://github.com/HiDeoo/vercel-env-push/blob/main/LICENSE) for more information.