actionhero
    Preparing search index...

    Class CLIAbstract

    An Actionhero CLI Command. For inputs, you can provide Options (--thing=stuff) with the "Inputs" object, or define Arguments in the name of the command (greet [name])

    Index

    Constructors

    constructor

    Properties

    description example initialize inputs name start

    Methods

    help run validate

    Constructors

    • Returns CLI

    Properties

    description: string

    The description of the CLI command (default this.name)

    example: string

    An example of how to run this CLI command

    initialize: boolean

    Should the server initialize before running this command?

    inputs: {
        [key: string]: {
            default?: string | boolean;
            description?: string;
            flag?: boolean;
            formatter?: Function;
            letter?: string;
            placeholder?: string;
            required?: boolean;
            requiredValue?: boolean;
            validator?: Function;
            variadic?: boolean;
        };
    }

    The inputs of the CLI command (default: {})

    name: string

    The name of the CLI command.

    start: boolean

    Should the server start before running this command?

    Methods

    • An optional method to append additional information to the --help response for this CLI command

      Returns void

    • The main "do something" method for this CLI command. It is an async method. If error is thrown in this method, it will be logged to STDERR, and the process will terminate with a non-0 exit code.

      Parameters

      • data: { [key: string]: any }

      Returns Promise<boolean>

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods