How to Add ENV vars using the CLI

[Resto]

Hey there. I’ve been clicking through the GUI to build a number of sites recently and decided to try out the CLI to make the deployment process more efficient.

I need to set 2 or 3 vars per site to get my app to work. Is there a way to set ENV vars per site using the CLI? Or is that part of the API still private and only accessible through the GUI?

Thanks

[perry]

hi there,

you can definitely used file based configuration to set up environment vars without going through the UI:

File-based configuration

but i don’t think we have an API endpoint for you to be able to do that programmatically per se. At least, i don’t see anything in here:

Netlify

So it would still have to be a bit manual, but not as clicky as going through the UI for each one. Does that help?

[Resto]

Hey @perry I’m familiar with the netlify.toml and file-based config options, but that doesn’t really fit the bill here. I’m deploying many sites using the same codebase, and simply modifying a few sensitive ENV vars per site. So they shouldn’t be checked into my rep, like in a config file.

Ideally I could run something like netlify sites:create --with-ci VUE_APP_VAR_1=blah VUE_APP_KEY=app12398unalskjh. Or even just do it in a few steps after retrieving the new site ID.

Does that distinction make sense?

I just looked at the Open API docs you sent over and there seems to be something in the build config section, but its use is a little murky. Anyone on your side know how I can use it?

[fool]

Your best advice on doing anything our UI can do via API will be in this article, @Resto:

[Support Guide] Understanding and using Netlify's API

Did you know that Netlify has an extensive public API? Anything that you configure in our Admin UI at https://app.netlify.com is managed using this same API, and you’re welcome to use it to create and configure your site(s) and perform most other operations on your account. We have an article on API Usage in our official documentation which shows how to do some common tasks like deploying your site and configuring it in great detail. It also talks about your options for authentication (since …

If you watch what our UI does when you save a variable, you can see a call like this:

HTTP PUT https://api.netlify.com/api/v1/site/YOUR_SITE_ID_HERE

with a value like this:

{"build_settings":
  {"env":
    {"EXISTING_VAR":"existing_val","NEW_VAR":"new_val"}
  }
}

Make sure you send ALL existing vars, but also, try it in the UI first to see the shape of the command so you make sure you aren’t missing anything - perhaps my test site didn’t have some other configuration that yours did and you’d need to send that along too

[Resto]

Super helpful, @fool thank you. The link to that Support Guide article is great. I’m wondering is there a way to make that part of Netlify’s docs more obvious? I’d consider myself somewhat of a “power” user who’s been using Netlify for at least 2+ years and had no idea it even existed until last week. I’m excited to dig in but wish I knew about it earlier! Thank you.

[fool]

That’s a great suggestion! I’ll bring it up with our tech writers during our weekly pairing. I think it is already linked from the “main” API article here: https://docs.netlify.com/api/get-started/#make-a-request - so if you have any more specific suggestions about how to surface it, they would be welcome!

[Resto]

Hey @fool I just spent a few minutes thinking about how to surface the API docs. You’re totally right that it’s clearly listed on the Netlify Docs sidebar. I think the main reason I never investigated it was because there was no “entry point” for me. I think if you sprinkled examples around the Docs that pointed to different API endpoints that would be really really valuable.

For example, I noticed you have a short mention of the API endpoints here: https://docs.netlify.com/site-deploys/create-deploys/#api-endpoints but if you designed it more like a callout box with a specific color or icon that would be helpful. And then use that same design pattern around the docs like in the build configuration section and other places as well. Just to give some examples to devs of how they can automate or leverage the API in specific ways instead of just having it sit on the sidebar on the docs.

Hope that makes sense. I’d love to be a part of this discussion moving forward so keep me in the loop!

[fool]

That is DELIGHTFULLY, DELICIOUSLY AWESOME feedback. We’ll discuss with the docs team on friday and if they have any followup comments they’ll probably hit you up in this thread!

Thanks again!

[jonsully]

Agreed! That’s an awesome approach. Maybe the docs could just have parallel tracks for how to do any given action - how to do it in the UI and how to do it via API. can’t wait to see where this goes!

—
Jon

[erez]

Following up here as we’ve released a built in command to manage environment variables:

CLI: New command to manage env variables

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: 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.

[Resto]

Hey @erez is this tool for shared ENV vars only? I don’t see a way to target a specific site in the docs.

[erez]

Hi @Resto, this is a command to manage environment variables for the currently linked site (run netlify link in a repo to link it).

You can use NETLIFY_SITE_ID env variable for a non linked site, and passing a site id similar to https://cli.netlify.com/commands/deploy does makes sense, but not supported as the moment.

You could however open a feature request for it in the CLI repo.