Interface CliOptions

The options of kizuki.

interface CliOptions {
    help: boolean;
    home: string | undefined;
    open: boolean;
    port: number;
}

Properties

help: boolean

True with --help or -h: print the help and stop.

home: string | undefined

The data folder from --home. undefined means use KIZUKI_HOME or ~/.kizuki.

open: boolean

Whether to open the dashboard in the browser. --no-open turns it off.

port: number

The port the dashboard runs on at 127.0.0.1, from --port. 3700 by default.