args 1.6.0

  • Readme
  • Changelog
  • Installing
  • 99

Parses raw command-line arguments into a set of options and values.

This library supports GNU and POSIX style options, and it works in both server-side and client-side apps.

Defining options #

First create an ArgParser:

var parser = ArgParser();

Then define a set of options on that parser using addOption() and addFlag(). Here's the minimal way to create an option named "name":


When an option can only be set or unset (as opposed to taking a string value), use a flag:


Flag options, by default, accept a 'no-' prefix to negate the option. You can disable the 'no-' prefix using the negatable parameter:

parser.addFlag('name', negatable: false);

Note: From here on out, "option" refers to both regular options and flags. In cases where the distinction matters, we'll use "non-flag option."

Options can have an optional single-character abbreviation, specified with the abbr parameter:

parser.addOption('mode', abbr: 'm');
parser.addFlag('verbose', abbr: 'v');

Options can also have a default value, specified with the defaultsTo parameter. The default value is used when arguments don't specify the option.

parser.addOption('mode', defaultsTo: 'debug');
parser.addFlag('verbose', defaultsTo: false);

The default value for non-flag options can be any string. For flags, it must be a bool.

To validate a non-flag option, you can use the allowed parameter to provide an allowed set of values. When you do, the parser throws an ArgParserException if the value for an option is not in the allowed set. Here's an example of specifying allowed values:

parser.addOption('mode', allowed: ['debug', 'release']);

You can use the callback parameter to associate a function with an option. Later, when parsing occurs, the callback function is invoked with the value of the option:

parser.addOption('mode', callback: (mode) => print('Got mode $mode'));
parser.addFlag('verbose', callback: (verbose) {
  if (verbose) print('Verbose');

The callbacks for all options are called whenever a set of arguments is parsed. If an option isn't provided in the args, its callback is passed the default value, or null if no default value is set.

Parsing arguments #

Once you have an ArgParser set up with some options and flags, you use it by calling ArgParser.parse() with a set of arguments:

var results = parser.parse(['some', 'command', 'line', 'args']);

These arguments usually come from the arguments to main(). For example:

main(List<String> args) {
  // ...
  var results = parser.parse(args);

However, you can pass in any list of strings. The parse() method returns an instance of ArgResults, a map-like object that contains the values of the parsed options.

var parser = ArgParser();
parser.addFlag('verbose', defaultsTo: true);
var results = parser.parse(['--mode', 'debug', 'something', 'else']);

print(results['mode']); // debug
print(results['verbose']); // true

By default, the parse() method allows additional flags and options to be passed after positional parameters unless -- is used to indicate that all further parameters will be positional. The positional arguments go into

print(; // ['something', 'else']

To stop parsing options as soon as a positional argument is found, allowTrailingOptions: false when creating the ArgParser.

Specifying options #

To actually pass in options and flags on the command line, use GNU or POSIX style. Consider this option:

parser.addOption('name', abbr: 'n');

You can specify its value on the command line using any of the following:

--name somevalue
-n somevalue

Consider this flag:

parser.addFlag('name', abbr: 'n');

You can set it to true using one of the following:


You can set it to false using the following:


Multiple flag abbreviations can be collapsed into a single argument. Say you define these flags:

  ..addFlag('verbose', abbr: 'v')
  ..addFlag('french', abbr: 'f')
  ..addFlag('iambic-pentameter', abbr: 'i');

You can set all three flags at once:


By default, an option has only a single value, with later option values overriding earlier ones; for example:

var parser = ArgParser();
var results = parser.parse(['--mode', 'on', '--mode', 'off']);
print(results['mode']); // prints 'off'

Multiple values can be parsed with addMultiOption(). With this method, an option can occur multiple times, and the parse() method returns a list of values:

var parser = ArgParser();
var results = parser.parse(['--mode', 'on', '--mode', 'off']);
print(results['mode']); // prints '[on, off]'

By default, values for a multi-valued option may also be separated with commas:

var parser = ArgParser();
parser.addOption('mode', allowMultiple: true);
var results = parser.parse(['--mode', 'on,off']);
print(results['mode']); // prints '[on, off]'

This can be disabled by passing splitCommas: false.

Defining commands #

In addition to options, you can also define commands. A command is a named argument that has its own set of options. For example, consider this shell command:

$ git commit -a

The executable is git, the command is commit, and the -a option is an option passed to the command. You can add a command using the addCommand method:

var parser = ArgParser();
var command = parser.addCommand('commit');

It returns another ArgParser, which you can then use to define options specific to that command. If you already have an ArgParser for the command's options, you can pass it in:

var parser = ArgParser();
var command = ArgParser();
parser.addCommand('commit', command);

The ArgParser for a command can then define options or flags:

command.addFlag('all', abbr: 'a');

You can add multiple commands to the same parser so that a user can select one from a range of possible commands. When parsing an argument list, you can then determine which command was entered and what options were provided for it.

var results = parser.parse(['commit', '-a']);
print(;   // "commit"
print(results.command['all']); // true

Options for a command must appear after the command in the argument list. For example, given the above parser, "git -a commit" is not valid. The parser tries to find the right-most command that accepts an option. For example:

var parser = ArgParser();
parser.addFlag('all', abbr: 'a');
var command = parser.addCommand('commit');
command.addFlag('all', abbr: 'a');

var results = parser.parse(['commit', '-a']);
print(results.command['all']); // true

Here, both the top-level parser and the "commit" command can accept a "-a" (which is probably a bad command line interface, admittedly). In that case, when "-a" appears after "commit", it is applied to that command. If it appears to the left of "commit", it is given to the top-level parser.

Dispatching Commands #

If you're writing a command-based application, you can use the CommandRunner and Command classes to help structure it. CommandRunner has built-in support for dispatching to Commands based on command-line arguments, as well as handling --help flags and invalid arguments. For example:

var runner = CommandRunner("git", "Distributed version control.")
  ..addCommand(StashCommand())['commit', '-a']); // Calls []

Custom commands are defined by extending the Command class. For example:

class CommitCommand extends Command {
  // The [name] and [description] properties must be defined by every
  // subclass.
  final name = "commit";
  final description = "Record changes to the repository.";

  CommitCommand() {
    // [argParser] is automatically created by the parent class.
    argParser.addFlag('all', abbr: 'a');

  // [run] may also return a Future.
  void run() {
    // [argResults] is set before [run()] is called and contains the options
    // passed to this command.

Commands can also have subcommands, which are added with addSubcommand. A command with subcommands can't run its own code, so run doesn't need to be implemented. For example:

class StashCommand extends Command {
  final String name = "stash";
  final String description = "Stash changes in the working directory.";

  StashCommand() {

CommandRunner automatically adds a help command that displays usage information for commands, as well as support for the --help flag for all commands. If it encounters an error parsing the arguments or processing a command, it throws a UsageException; your main() method should catch these and print them appropriately. For example: {
  if (error is! UsageException) throw error;
  exit(64); // Exit code 64 indicates a usage error.

Displaying usage #

You can automatically generate nice help text, suitable for use as the output of --help. To display good usage information, you should provide some help text when you create your options.

To define help text for an entire option, use the help: parameter:

parser.addOption('mode', help: 'The compiler configuration',
    allowed: ['debug', 'release']);
parser.addFlag('verbose', help: 'Show additional diagnostic info');

For non-flag options, you can also provide a help string for the parameter:

parser.addOption('out', help: 'The output path', valueHelp: 'path',
    allowed: ['debug', 'release']);

For non-flag options, you can also provide detailed help for each expected value by using the allowedHelp: parameter:

parser.addOption('arch', help: 'The architecture to compile for',
    allowedHelp: {
      'ia32': 'Intel x86',
      'arm': 'ARM Holding 32-bit chip'

To display the help, use the usage getter:


The resulting string looks something like this:

--mode            The compiler configuration
                  [debug, release]

--out=<path>      The output path
--[no-]verbose    Show additional diagnostic info
--arch            The architecture to compile for
      [arm]       ARM Holding 32-bit chip
      [ia32]      Intel x86

1.6.0 #

  • Remove help from the list of commands in usage.
  • Remove the blank lines in usage which separated the help for options that happened to span multiple lines.

1.5.4 #

  • Fix a bug with option names containing underscores.
  • Point towards CommandRunner in the docs for ArgParser.addCommand since it is what most authors will want to use instead.

1.5.3 #

  • Improve arg parsing performance: use queues instead of lists internally to get linear instead of quadratic performance, which is important for large numbers of args (>1000). And, use simple string manipulation instead of regular expressions for a 1.5x improvement everywhere.
  • No longer automatically add a 'help' option to commands that don't validate their arguments (fix #123).

1.5.2 #

  • Added support for usageLineLength in CommandRunner

1.5.1 #

  • Added more comprehensive word wrapping when usageLineLength is set.

1.5.0 #

  • Add usageLineLength to control word wrapping usage text.

1.4.4 #

  • Set max SDK version to <3.0.0, and adjust other dependencies.

1.4.3 #

  • Display the default values for options with allowedHelp specified.

1.4.2 #

  • Narrow the SDK constraint to only allow SDK versions that support FutureOr.

1.4.1 #

  • Fix the way default values for multi-valued options are printed in argument usage.

1.4.0 #

  • Deprecated OptionType.FLAG, OptionType.SINGLE, and OptionType.MULTIPLE in favor of OptionType.flag, OptionType.single, and OptionType.multiple which follow the style guide.

  • Deprecated Option.abbreviation and Option.defaultValue in favor of Option.abbr and Option.defaultsTo. This makes all of Option's fields match the corresponding parameters to ArgParser.addOption().

  • Deprecated the allowMultiple and splitCommas arguments to ArgParser.addOption() in favor of a separate ArgParser.addMultiOption() method. This allows us to provide more accurate type information, and to avoid adding flags that only make sense for multi-options in places where they might be usable for single-value options.

1.3.0 #

  • Type's return value as FutureOr<T>.

1.2.0 #

  • Type the callback parameter to ArgParser.addOption() as Function rather than void Function(value). This allows strong-mode users to write callback: (String value) { ... } rather than having to manually cast value to a String (or a List<String> with allowMultiple: true).

1.1.0 #

  • ArgParser.parse() now takes an Iterable<String> rather than a List<String>.

  • ArgParser.addOption()'s allowed option now takes an Iterable<String> rather than a List<String>.

1.0.2 #

  • Fix analyzer warning

1.0.1 #

  • Fix a fuzzy arrow type warning.

1.0.0 #

  • Breaking change: The allowTrailingOptions argument to new ArgumentParser() defaults to true instead of false.

  • Add new ArgParser.allowAnything(). This allows any input, without parsing any options.

0.13.7 #

  • Add explicit support for forwarding the value returned by to This worked unintentionally prior to 0.13.6+1.

  • Add type arguments to CommandRunner and Command to indicate the return values of the run() functions.

0.13.6+1 #

  • When a CommandRunner is passed --help before any commands, it now prints the usage of the chosen command.

0.13.6 #

  • ArgParser.parse() now throws an ArgParserException, which implements FormatException and has a field that lists the commands that were parsed.

  • If encounters a parse error for a subcommand, it now prints the subcommand's usage rather than the global usage.

0.13.5 #

  • Allow CommandRunner.argParser and Command.argParser to be overridden in strong mode.

0.13.4+2 #

  • Fix a minor documentation error.

0.13.4+1 #

  • Ensure that multiple-value arguments produce reified List<String>s.

0.13.4 #

  • By default, only the first line of a command's description is included in its parent runner's usage string. This returns to the default behavior from before 0.13.3+1.

  • A Command.summary getter has been added to explicitly control the summary that appears in the parent runner's usage string. This getter defaults to the first line of the description, but can be overridden if the user wants a multi-line summary.

0.13.3+6 #

  • README fixes.

0.13.3+5 #

  • Make strong mode clean.

0.13.3+4 #

  • Use the proper usage getter in the README.

0.13.3+3 #

  • Add an explicit default value for the allowTrailingOptions parameter to new ArgParser(). This doesn't change the behavior at all; the option already defaulted to false, and passing in null still works.

0.13.3+2 #

  • Documentation fixes.

0.13.3+1 #

  • Print all lines of multi-line command descriptions.

0.13.2 #

  • Allow option values that look like options. This more closely matches the behavior of getopt, the de facto standard for option parsing.

0.13.1 #

  • Add ArgParser.addSeparator(). Separators allow users to group their options in the usage text.

0.13.0 #

  • Breaking change: An option that allows multiple values will now automatically split apart comma-separated values. This can be controlled with the splitCommas option.

0.12.2+6 #

  • Remove the dependency on the collection package.

0.12.2+5 #

  • Add syntax highlighting to the README.

0.12.2+4 #

  • Add an example of using command-line arguments to the README.

0.12.2+3 #

  • Fixed implementation of ArgResults.options to really use Iterable

0.12.2+2 #

  • Updated dependency constraint on unittest.

  • Formatted source code.

  • Fixed use of deprecated API in example.

0.12.2+1 #

  • Fix the built-in help command for CommandRunner.

0.12.2 #

  • Add CommandRunner and Command classes which make it easy to build a command-based command-line application.

  • Add an ArgResults.arguments field, which contains the original argument list.

0.12.1 #

  • Replace ArgParser.getUsage() with ArgParser.usage, a getter. ArgParser.getUsage() is now deprecated, to be removed in args version 1.0.0.

0.12.0+2 #

  • Widen the version constraint on the collection package.

0.12.0+1 #

  • Remove the documentation link from the pubspec so this is linked to by default.

0.12.0 #

  • Removed public constructors for ArgResults and Option.

  • ArgResults.wasParsed() can be used to determine if an option was actually parsed or the default value is being returned.

  • Replaced isFlag and allowMultiple fields in the Option class with a three-value OptionType enum.

  • Options may define valueHelp which will then be shown in the usage.

0.11.0 #

  • Move handling trailing options from ArgParser.parse() into ArgParser itself. This lets subcommands have different behavior for how they handle trailing options.

0.10.0+2 #

  • Usage ignores hidden options when determining column widths.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  args: ^1.6.0

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:args/args.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Apr 3, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6

Health suggestions

Fix lib/src/arg_parser.dart. (-1.99 points)

Analysis of lib/src/arg_parser.dart reported 4 hints:

line 178 col 12: 'allowMultiple' is deprecated and shouldn't be used. Use addMultiOption() instead..

line 178 col 32: 'splitCommas' is deprecated and shouldn't be used. Use addMultiOption() instead..

line 187 col 10: 'splitCommas' is deprecated and shouldn't be used. Use addMultiOption() instead..

line 187 col 38: 'allowMultiple' is deprecated and shouldn't be used. Use addMultiOption() instead..

Maintenance suggestions

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and args.dart. Packages with multiple examples should provide example/

For more information see the pub package layout conventions.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.3.0 <3.0.0
Dev dependencies
pedantic ^1.4.0
test ^1.5.1