Webdash CLI

The webdash CLI is mainly responsible for serving the webdash dashboard & its API.

Serve

serve is the default command for the CLI. Which means running npx webdash serve or simply npx webdash are equivalent.

Customize port

Webdash is served on port 3456 by default. You can customize the port by passing the --port option.

npx webdash --port 80

Bind to host

You can bind to a different hostname than localhost. For example, you can bind to 0.0.0.0 if you'd like to access webdash from a different computer on the network.

npx webdash --host 0.0.0.0

Config

webdash config will generate a webdash.json configuration file where it's running. This is useful when you're running a global instance of webdash and you need to have a local configuration file per project.

Webdash version

If you'd like to check which version of webdash you're running, you can simply run:

npx webdash --version

Regenerating the webdash.json config

If you'd like to regenerate your webdash.json configuration file, you can do so by running:

#you have to delete the previous configuration file first
rm webdash.json
node ./node_modules/webdash/scripts/install.js