Skip to content
This repository was archived by the owner on Sep 12, 2019. It is now read-only.

Commit c45c694

Browse files
author
sw-yx
committed
add notes on readme
1 parent a7a3942 commit c45c694

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Netlify CLI plugin for local dev experience.
44

55
## What is Netlify Dev?
66

7-
Netlify Dev brings the power of Netlify's Edge Logic layer, serverless functions and [add-on ecosystem](#using-add-ons) to your local laptop. It runs Netlify's production routing engine in a local dev server to make all redirects, proxy rules, function routes or add-on routes available locally and injects the correct environment variables from your site environment, installed add-ons or your netlify.toml file into your build and function environment.
7+
Netlify Dev brings the power of Netlify's Edge Logic layer, [serverless functions](#netlify-functions) and [add-on ecosystem](#using-add-ons) to your local laptop. It runs Netlify's production routing engine in a local dev server to make all redirects, proxy rules, function routes or add-on routes available locally and injects the correct environment variables from your site environment, installed add-ons or your netlify.toml file into your build and function environment.
88

99
It automatically detects common tools like Gatsby, Hugo, React Static, Eleventy, and more, to give a zero config setup for your local dev server and can help scaffolding new functions as you work on them.
1010

@@ -14,6 +14,17 @@ It automatically detects common tools like Gatsby, Hugo, React Static, Eleventy,
1414
- `netlify dev:exec <command>` runs a shell command within the netlify dev environment
1515
- `netlify functions:create` bootstrap a new function
1616

17+
As these commands are expected to be frequently used, it may be helpful to define aliases in your terminal (Mac: [bash](https://jonsuh.com/blog/bash-command-line-shortcuts/), [zsh](https://askubuntu.com/questions/758496/how-to-make-a-permanent-alias-in-oh-my-zsh), Windows: [doskey](https://stackoverflow.com/questions/20530996/aliases-in-windows-command-prompt), [registry](https://stackoverflow.com/questions/20530996/aliases-in-windows-command-prompt)) to your personal preference. For example:
18+
19+
```
20+
## ~/.zshrc
21+
alias ndeploy="netlify deploy --prod"
22+
alias nd="netlify dev"
23+
alias ndl="netlify dev --live"
24+
alias nfc="netlify functions:create"
25+
alias ndx="netlify dev:exec "
26+
```
27+
1728
## Using the beta
1829

1930
Currently the Netlify dev plugin is in private beta. You'll need to follow these steps to enable it:

0 commit comments

Comments
 (0)