Command class abstract

A dox command that a package or the app adds.

class HelloCommand extends Command {
  @override
  String get name => 'hello';

  @override
  String get description => 'Say hello';

  @override
  Future<void> run(List<String> args) async {
    print('Hello ${args.join(' ')}');
  }
}

dox hello world calls run(['world']). To fail, set exitCode from dart:io (eg. exitCode = 1) or throw. The dox CLI exits with that code when run is done.

Constructors

Command()

Properties

description → String
one line for dox help
no setter
hashCode → int
The hash code for this object.
no setterinherited
name → String
the name after dox, like queue:table
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
usage → String
how to call it, like make:report <name>. Shown by dox help. The default is name.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
run(List<String> args) → Future<void>
run the command. args are the words after the name.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited