aboutsummaryrefslogtreecommitdiff
path: root/node_modules/nodemon/doc/cli
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/nodemon/doc/cli')
-rw-r--r--node_modules/nodemon/doc/cli/authors.txt8
-rw-r--r--node_modules/nodemon/doc/cli/config.txt44
-rw-r--r--node_modules/nodemon/doc/cli/help.txt29
-rw-r--r--node_modules/nodemon/doc/cli/logo.txt20
-rw-r--r--node_modules/nodemon/doc/cli/options.txt36
-rw-r--r--node_modules/nodemon/doc/cli/topics.txt8
-rw-r--r--node_modules/nodemon/doc/cli/usage.txt3
-rw-r--r--node_modules/nodemon/doc/cli/whoami.txt9
8 files changed, 157 insertions, 0 deletions
diff --git a/node_modules/nodemon/doc/cli/authors.txt b/node_modules/nodemon/doc/cli/authors.txt
new file mode 100644
index 0000000..6c77a12
--- /dev/null
+++ b/node_modules/nodemon/doc/cli/authors.txt
@@ -0,0 +1,8 @@
+
+ Remy Sharp - author and maintainer
+ https://github.com/remy
+ https://twitter.com/rem
+
+ Contributors: https://github.com/remy/nodemon/graphs/contributors ❤︎
+
+ Please help make nodemon better: https://github.com/remy/nodemon/
diff --git a/node_modules/nodemon/doc/cli/config.txt b/node_modules/nodemon/doc/cli/config.txt
new file mode 100644
index 0000000..5de9bba
--- /dev/null
+++ b/node_modules/nodemon/doc/cli/config.txt
@@ -0,0 +1,44 @@
+
+ Typically the options to control nodemon are passed in via the CLI and are
+ listed under: nodemon --help options
+
+ nodemon can also be configured via a local and global config file:
+
+ * $HOME/nodemon.json
+ * $PWD/nodemon.json OR --config <file>
+ * nodemonConfig in package.json
+
+ All config options in the .json file map 1-to-1 with the CLI options, so a
+ config could read as:
+
+ {
+ "ext": "*.pde",
+ "verbose": true,
+ "exec": "processing --sketch=game --run"
+ }
+
+ There are a limited number of variables available in the config (since you
+ could use backticks on the CLI to use a variable, backticks won't work in
+ the .json config).
+
+ * {{pwd}} - the current directory
+ * {{filename}} - the filename you pass to nodemon
+
+ For example:
+
+ {
+ "ext": "*.pde",
+ "verbose": true,
+ "exec": "processing --sketch={{pwd}} --run"
+ }
+
+ The global config file is useful for setting up default executables
+ instead of repeating the same option in each of your local configs:
+
+ {
+ "verbose": true,
+ "execMap": {
+ "rb": "ruby",
+ "pde": "processing --sketch={{pwd}} --run"
+ }
+ }
diff --git a/node_modules/nodemon/doc/cli/help.txt b/node_modules/nodemon/doc/cli/help.txt
new file mode 100644
index 0000000..7ba4ff2
--- /dev/null
+++ b/node_modules/nodemon/doc/cli/help.txt
@@ -0,0 +1,29 @@
+ Usage: nodemon [options] [script.js] [args]
+
+ Options:
+
+ --config file ............ alternate nodemon.json config file to use
+ -e, --ext ................ extensions to look for, ie. js,pug,hbs.
+ -x, --exec app ........... execute script with "app", ie. -x "python -v".
+ -w, --watch path ......... watch directory "path" or files. use once for
+ each directory or file to watch.
+ -i, --ignore ............. ignore specific files or directories.
+ -V, --verbose ............ show detail on what is causing restarts.
+ -- <your args> ........... to tell nodemon stop slurping arguments.
+
+ Note: if the script is omitted, nodemon will try to read "main" from
+ package.json and without a nodemon.json, nodemon will monitor .js, .mjs, .coffee,
+ .litcoffee, and .json by default.
+
+ For advanced nodemon configuration use nodemon.json: nodemon --help config
+ See also the sample: https://github.com/remy/nodemon/wiki/Sample-nodemon.json
+
+ Examples:
+
+ $ nodemon server.js
+ $ nodemon -w ../foo server.js apparg1 apparg2
+ $ nodemon --exec python app.py
+ $ nodemon --exec "make build" -e "styl hbs"
+ $ nodemon app.js -- --config # pass config to app.js
+
+ \x1B[1mAll options are documented under: \x1B[4mnodemon --help options\x1B[0m
diff --git a/node_modules/nodemon/doc/cli/logo.txt b/node_modules/nodemon/doc/cli/logo.txt
new file mode 100644
index 0000000..150f97f
--- /dev/null
+++ b/node_modules/nodemon/doc/cli/logo.txt
@@ -0,0 +1,20 @@
+ ; ;
+ kO. x0
+ KMX, .:x0kc. 'KMN
+ 0MMM0: 'oKMMMMMMMXd, ;OMMMX
+ oMMMMMWKOONMMMMMMMMMMMMMWOOKWMMMMMx
+ OMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMK.
+ .oWMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMd.
+ KMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMN
+ KMMMMMMMMMMMMMMW0k0WMMMMMMMMMMMMMMW
+ KMMMMMMMMMMMNk:. :xNMMMMMMMMMMMW
+ KMMMMMMMMMMK OMMMMMMMMMMW
+ KMMMMMMMMMMO xMMMMMMMMMMN
+ KMMMMMMMMMMO xMMMMMMMMMMN
+ KMMMMMMMMMMO xMMMMMMMMMMN
+ KMMMMMMMMMMO xMMMMMMMMMMN
+ KMMMMMMMMMMO xMMMMMMMMMMN
+ KMMMMMMMMMNc ;NMMMMMMMMMN
+ KMMMMMW0o' .lOWMMMMMN
+ KMMKd; ,oKMMN
+ kX: ,K0 \ No newline at end of file
diff --git a/node_modules/nodemon/doc/cli/options.txt b/node_modules/nodemon/doc/cli/options.txt
new file mode 100644
index 0000000..598ae63
--- /dev/null
+++ b/node_modules/nodemon/doc/cli/options.txt
@@ -0,0 +1,36 @@
+
+Configuration
+ --config <file> .......... alternate nodemon.json config file to use
+ --exitcrash .............. exit on crash, allows nodemon to work with other watchers
+ -i, --ignore ............. ignore specific files or directories
+ --no-colors .............. disable color output
+ --signal <signal> ........ use specified kill signal instead of default (ex. SIGTERM)
+ -w, --watch path ......... watch directory "dir" or files. use once for each
+ directory or file to watch
+ --no-update-notifier ..... opt-out of update version check
+
+Execution
+ -C, --on-change-only ..... execute script on change only, not startup
+ --cwd <dir> .............. change into <dir> before running the script
+ -e, --ext ................ extensions to look for, ie. "js,pug,hbs"
+ -I, --no-stdin ........... nodemon passes stdin directly to child process
+ --spawn .................. force nodemon to use spawn (over fork) [node only]
+ -x, --exec app ........... execute script with "app", ie. -x "python -v"
+ -- <your args> ........... to tell nodemon stop slurping arguments
+
+Watching
+ -d, --delay n ............ debounce restart for "n" seconds
+ -L, --legacy-watch ....... use polling to watch for changes (typically needed
+ when watching over a network/Docker)
+ -P, --polling-interval ... combined with -L, milliseconds to poll for (default 100)
+
+Information
+ --dump ................... print full debug configuration
+ -h, --help ............... default help
+ --help <topic> ........... help on a specific feature. Try "--help topics"
+ -q, --quiet .............. minimise nodemon messages to start/stop only
+ -v, --version ............ current nodemon version
+ -V, --verbose ............ show detail on what is causing restarts
+
+
+> Note that any unrecognised arguments are passed to the executing command.
diff --git a/node_modules/nodemon/doc/cli/topics.txt b/node_modules/nodemon/doc/cli/topics.txt
new file mode 100644
index 0000000..9fe3e2b
--- /dev/null
+++ b/node_modules/nodemon/doc/cli/topics.txt
@@ -0,0 +1,8 @@
+
+ options .................. show all available nodemon options
+ config ................... default config options using nodemon.json
+ authors .................. contributors to this project
+ logo ..................... <3
+ whoami ................... I, AM, NODEMON \o/
+
+ Please support https://github.com/remy/nodemon/
diff --git a/node_modules/nodemon/doc/cli/usage.txt b/node_modules/nodemon/doc/cli/usage.txt
new file mode 100644
index 0000000..bca98b5
--- /dev/null
+++ b/node_modules/nodemon/doc/cli/usage.txt
@@ -0,0 +1,3 @@
+ Usage: nodemon [nodemon options] [script.js] [args]
+
+ See "nodemon --help" for more.
diff --git a/node_modules/nodemon/doc/cli/whoami.txt b/node_modules/nodemon/doc/cli/whoami.txt
new file mode 100644
index 0000000..efc3382
--- /dev/null
+++ b/node_modules/nodemon/doc/cli/whoami.txt
@@ -0,0 +1,9 @@
+__/\\\\\_____/\\\_______/\\\\\_______/\\\\\\\\\\\\_____/\\\\\\\\\\\\\\\__/\\\\____________/\\\\_______/\\\\\_______/\\\\\_____/\\\_
+ _\/\\\\\\___\/\\\_____/\\\///\\\____\/\\\////////\\\__\/\\\///////////__\/\\\\\\________/\\\\\\_____/\\\///\\\____\/\\\\\\___\/\\\_
+ _\/\\\/\\\__\/\\\___/\\\/__\///\\\__\/\\\______\//\\\_\/\\\_____________\/\\\//\\\____/\\\//\\\___/\\\/__\///\\\__\/\\\/\\\__\/\\\_
+ _\/\\\//\\\_\/\\\__/\\\______\//\\\_\/\\\_______\/\\\_\/\\\\\\\\\\\_____\/\\\\///\\\/\\\/_\/\\\__/\\\______\//\\\_\/\\\//\\\_\/\\\_
+ _\/\\\\//\\\\/\\\_\/\\\_______\/\\\_\/\\\_______\/\\\_\/\\\///////______\/\\\__\///\\\/___\/\\\_\/\\\_______\/\\\_\/\\\\//\\\\/\\\_
+ _\/\\\_\//\\\/\\\_\//\\\______/\\\__\/\\\_______\/\\\_\/\\\_____________\/\\\____\///_____\/\\\_\//\\\______/\\\__\/\\\_\//\\\/\\\_
+ _\/\\\__\//\\\\\\__\///\\\__/\\\____\/\\\_______/\\\__\/\\\_____________\/\\\_____________\/\\\__\///\\\__/\\\____\/\\\__\//\\\\\\_
+ _\/\\\___\//\\\\\____\///\\\\\/_____\/\\\\\\\\\\\\/___\/\\\\\\\\\\\\\\\_\/\\\_____________\/\\\____\///\\\\\/_____\/\\\___\//\\\\\_
+ _\///_____\/////_______\/////_______\////////////_____\///////////////__\///______________\///_______\/////_______\///_____\/////__ \ No newline at end of file