Overview

This page will cover the exposed scripts and how to use them.

• Setup
• core:logs:watch
• core:usage:info
• core:task:run

Setup

To setup the CLI access for your project, ensure you enable the following in your Application configuration settings:

const application = new Application({
	// ...
	enableCli: true,
	password: 'password', // required: this is used to authenticate the CLI connection.
	hostname: 'localhost', // optional, defaults to `localhost`.
	port: 3000, // optional, defaults to `36445`.
});

core:logs:watch

This script is used to watch the log output and pass it through to your command line, you can use this to see the output of your application in real time.

core:usage:info

This script is used to get the current system memory, heap information, and object counts.

core:task:run

This script will give you a list of tasks your project has registered that can be used to run manual or scheduled tasks on demand.