CLI: New command to manage env variables

erez · September 2, 2020, 4:45pm

We’ve shipped a new command for the CLI to manage environment variables.
This feature is 100% community contributed by @Pyrax who did an amazing job:

github.com/netlify/cli

feat(env): add command to list/get/set/import environment variables

netlify:master ← Pyrax:feat/cmd-env

opened 12:43PM - 29 Aug 20 UTC

Pyrax

+810 -25

**- Summary** Closes #1011 This PR introduces commands for managing enviro…nment variables from the CLI. It uses the Netlify API to set environment variables for the current site in the UI. | Command | Description | | -------------- | --------------- | | `netlify env:list` | Shows a table of env variables including those set in `netlify.toml`. | | `netlify env:get NAME` | Prints the value of a specified variable including those set in `netlify.toml`. | | `netlify env:set NAME VALUE` | Sets an environment variable in the UI. | | `netlify env:set NAME` | Removes an environment variable in the UI. | | `netlify env:import FILE_NAME` | Imports environment variables from `.env` files and sets them in the UI. | | `netlify env:import --replaceExisting FILE_NAME` | Imports environment variables from `.env` files while deleting any previously set variables in the UI. Can be useful for e.g. renaming variables. | For the manipulation commands `netlify env:import` and `netlify env:set` with the `--json` flag it returns all variables which are afterwards present for the site in the UI. **- Test plan** Automated tests are available in `/tests/command.env.test.js`. They are run serial because they create a test site on Netlify for making use of the API. This is similar to what is done in the tests for addons. Therefore, I also moved two functions into `/tests/utils` for re-use. Test execution (total execution time ~ 30s): ``` npx ava --verbose command.env.test.js creating new site for tests: netlify-test-env-ocanhpby ✔ env:list --json should return empty object if no vars set (2.1s) ✔ env:get --json should return empty object if var not set (2.1s) ✔ env:set --json should create and return new var (2.5s) ✔ env:set --json should update existing var (2.3s) ✔ env:get --json should return value of existing var (2.2s) ✔ env:import should throw error if file not exists (2s) ✔ env:import --json should import new vars and override existing vars (2.4s) ✔ env:get --json should return value of var from netlify.toml (2s) ✔ env:list --json should return list of vars with netlify.toml taking priority (2s) ✔ env:set --json should unset var if value is set empty (2.3s) ✔ env:import --json --replace-existing should replace all existing vars and return imported (2.5s) Performing cleanup deleting test site "netlify-test-env-ocanhpby". 9189194a-dfaf-4e3f-8e0d-9c9880035690 11 tests passed ``` **- Description for the changelog** feat(env): add command to list/get/set/import environment variables **- A picture of a cute animal (not mandatory but encouraged)** ![IMG_2019_AOJQW0312KMA](https://user-images.githubusercontent.com/4885581/91636550-cd647080-ea01-11ea-8882-c9e7d0a02c64.jpg)

Docs for the new command can be found here.

To use the new command you’ll need to upgrade to version v2.60.1 or above by running npm install netlify-cli -g.

We marked this command as Beta since it is a new feature and we would like to get some feedback before committing to the API.

You can submit feedback here or in the CLI repo.

Topic		Replies	Views
How to Add ENV vars using the CLI Support deployment , netlify-api , netlify-cli , environment-vars	11	2818	September 2, 2020
Can't change Base URL at build time using CLI Support deployment , netlify-cli , nextjs	1	34	July 19, 2024
Filter and export environment variables as .env Updates environment-vars , updates	1	881	December 30, 2022
Accessing Environment Variables via Script Support environment-vars	2	676	May 27, 2019
Build Environment Variables in Netlify with Create-React-App Issue Support netlify-newbie , environment-vars	8	3740	December 17, 2021

CLI: New command to manage env variables

Related topics