usageExamples property

  1. @override
String get usageExamples
override

Commands can override this getter to add examples to the usage help text.

Implementation

@override
String get usageExamples {
  return '''\n
Examples

Show the live overview of the project.

  \$ $baseCommand top


Show the live overview of a specific project.

  \$ $baseCommand top --project my-project


Refresh the status every 30 seconds.

  \$ $baseCommand top --interval 30s

''';
}