openmixer — generated API reference
    Preparing search index...

    Interface ServerCli

    The parsed CLI layer: network overrides + the state dir + config file + help request.

    interface ServerCli {
        configFile?: string;
        help: boolean;
        overrides: { host?: string; port?: number };
        stateDir?: string;
    }
    Index
    configFile? help overrides stateDir?
    configFile?: string

    --config — a JSON server-config file (rig preset etc.; see config.ts).

    help: boolean

    --help was requested.

    overrides: { host?: string; port?: number }

    The --web-host / --web-port fields set on the command line (absent flag = absent field).

    Type Declaration

    • Optionalhost?: string

      Web bind address.

    • Optionalport?: number

      Web (HTTP) port. 0 = ephemeral (tests).

    stateDir?: string

    --state-dir — where persisted state (network settings included) lives.

    Settings
    Member Visibility

    On This Page
    Properties