Skip to content

Commit b80d729

Browse files
committed
Update README.md
1 parent bc28afc commit b80d729

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
# netlify-vars
22

3-
Just a simple utility for pulling environment variables from your Netlify site to your local machine.
3+
This project extracts environment variables from your Netlify site.
4+
5+
This can be helpful if you've got lots of variables defined in the Netlify UI that you'd like to backup and/or sync to your local development environment.
6+
7+
You'll need to create a [personal access token](https://app.netlify.com/user/applications) to grab data from the Netlify API. Once you've got your token, just export that value as an environment variable called `NETLIFY_ACCESS_TOKEN`. You can also pass your token on the command, as shown below).
8+
9+
Install the script...
410

511
```
612
$ npm install ample/netlify-vars -g
713
```
814

9-
You'll need to create an API access token and call the script like, so...
15+
When calling the script, just pass the name of your Netlify site and it will return the goods to standard-out. You can then pipe that output to a file, if you're feeling frisky.
1016

1117
```
12-
NETLIFY_ACCESS_TOKEN=... netlify-vars <your-site-name>
18+
$ NETLIFY_ACCESS_TOKEN=your-token-here netlify-vars <your-site-name>
1319
```

0 commit comments

Comments
 (0)