Type Alias CliOptions

CliOptions: Record<string, any> & {
    hideWelcomeMessage?: boolean;
    logLevel?: CliLogLevel;
    terminalOptions?: ITerminalOptions & ITerminalInitOnlyOptions;
    usersModule?: {
        enabled: boolean;
        hideUserName?: boolean;
        reloadPageOnUserChange?: boolean;
    };
    welcomeMessage?: {
        message?: string;
        show?: "always"
        | "once"
        | "daily"
        | "never";
    };
}

Options for the CLI

Type declaration

  • OptionalhideWelcomeMessage?: boolean

    If true, the welcome message is hidden

    Default

    false
  • OptionallogLevel?: CliLogLevel

    The minimum log level to display

  • OptionalterminalOptions?: ITerminalOptions & ITerminalInitOnlyOptions

    Custom terminal options

  • OptionalusersModule?: { enabled: boolean; hideUserName?: boolean; reloadPageOnUserChange?: boolean }

    Users module options

    • enabled: boolean

      If true, the users module is enabled

    • OptionalhideUserName?: boolean

      Hide the prompt to display when the CLI is ready to accept input

    • OptionalreloadPageOnUserChange?: boolean

      Reload the page when the user changes

  • OptionalwelcomeMessage?: { message?: string; show?: "always" | "once" | "daily" | "never" }

    The welcome message options

    • Optionalmessage?: string

      The message to display

    • Optionalshow?: "always" | "once" | "daily" | "never"

      When to show the welcome message

      Default

      'always'

Settings

Member Visibility