cli_util

Description:

cli util

A package to help in building Dart command-line apps.
What's this? #
package:cli_util provides:

utilities to find the Dart SDK directory (getSdkPath())
utilities to find the settings directory for a tool (applicationConfigHome())
utilities to aid in showing rich CLI output and progress information (cli_logging.dart)

Locating the Dart SDK #
import 'dart:io';

import 'package:cli_util/cli_util.dart';
import 'package:path/path.dart' as path;

main(args) {
// Get sdk dir from cli_util.
var sdkPath = getSdkPath();

// Do stuff... For example, print version string
var versionFile = File(path.join(sdkPath, 'version'));
print(versionFile.readAsStringSync());
}
copied to clipboard
Displaying output and progress #
package:cli_util can also be used to help CLI tools display output and progress.
It has a logging mechanism which can help differentiate between regular tool
output and error messages, and can facilitate having a more verbose (-v) mode for
output.
In addition, it can display an indeterminate progress spinner for longer running
tasks, and optionally display the elapsed time when finished:
import 'package:cli_util/cli_logging.dart';

void main(List<String> args) async {
var verbose = args.contains('-v');
var logger = verbose ? Logger.verbose() : Logger.standard();

logger.stdout('Hello world!');
logger.trace('message 1');
await Future.delayed(Duration(milliseconds: 200));
logger.trace('message 2');
logger.trace('message 3');

var progress = logger.progress('doing some work');
await Future.delayed(Duration(seconds: 2));
progress.finish(showTiming: true);

logger.stdout('All ${logger.ansi.emphasized('done')}.');
logger.flush();
}
copied to clipboard
Features and bugs #
Please file feature requests and bugs at the issue tracker.