BARGS
    Preparing search index...

    Interface CreateOptions

    Options for bargs().

    interface CreateOptions {
        completion?: boolean;
        description?: string;
        epilog?: string | false;
        theme?: ThemeInput;
        version?: string;
    }
    Index

    Properties

    completion? description? epilog? theme? version?

    Properties

    completion?: boolean

    Enable shell completion support.

    When true, the CLI will respond to:

    • --completion-script <shell> - Output shell completion script
    • --get-bargs-completions <shell> <...words> - Return completion candidates

    Supported shells: bash, zsh, fish

    bargs('mytool', { completion: true })
      .command('build', ...)
      .parseAsync();

    // Then run: mytool --completion-script bash >> ~/.bashrc
    description?: string

    Description shown in help

    epilog?: string | false

    Epilog text shown after help output

    theme?: ThemeInput

    Color theme for help output

    version?: string

    Version string (enables --version flag)

    Settings

    Member Visibility

    On This Page

    Properties