diff --git a/Commands.md b/Commands.md new file mode 100644 index 0000000..3c54eef --- /dev/null +++ b/Commands.md @@ -0,0 +1,15 @@ +Statping includes a couple of useful commands. + +# `statping` +Running `statping` would any environment variables, parameters or flags added will start the server on `localhost:8080`. + +### Flags +- `--port` Port address to run the HTTP server (default `8080`) +- `--ip` Run HTTP server as a different host (default: `0.0.0.0`) +- `--verbose` Set Verbose logging mode. (default: 2 [info]) + +# `statping assets` +The assets command will extract all of the JS, CSS, SCSS, and static images into the `assets` folder. It will create this folder if it has permission to in the current working directory. + +# `statping env` +This command will echo all of the known variables from the `config.yml` file, or from set environment variables. \ No newline at end of file