| Branch | MSVC 2015-2017 CLANG 6, 10-12 GCC 7-9 |
MSVC 2019-2026 CLANG 13-22 GCC 10-15 |
Test Coverage |
|---|---|---|---|
| master | |||
| dev | |||
| 6.2.x |
C++ command line parser toolkit for kids of all ages.
- GNU style command lines (-o, --output=FILE, etc.)
- Parses to any supplied (or implicitly created) variable whose type is:
- Default constructible
- Copyable
- Either assignable from string, constructible from string, has an istream extraction operator, or has a specialization of Cli::Convert::fromString<T>().
- Renders help text and usage errors.
- Option definitions can be scattered across multiple files.
- Git style subcommands.
- Response files (requires
<filesystem>support). - Convert argv to/from command line with Windows, Posix, or GNU semantics.
- Word wrap arbitrary paragraphs and simple text tables for console output.
- Works whether or not exceptions and RTTI are disabled.
- Distributed under the Boost Software License, Version 1.0.
Check out the complete documentation, contains many examples, and the quick reference.
#include "dimcli/cli.h"
#include <iostream>
#include <string>
using namespace std;
int main(int argc, char * argv[]) {
Dim::Cli cli;
// Define option that populates an existing variable.
int count;
cli.opt(&count, "c n count", 1).desc("Times to say hello.");
// Or, define option without referencing an existing variable. The variable
// to populate is then implicitly allocated and the returned object is used
// like a smart pointer to access it.
auto & name = cli.opt<string>("name", "Unknown")
.desc("Who to greet.");
// Parse command line.
if (!cli.parse(argc, argv))
return cli.printError(cerr);
// Access the options.
if (!name)
cout << "Greeting the unknown." << endl;
for (int i = 0; i < count; ++i)
cout << "Hello " << *name << "!" << endl;
return 0;
}What it does when run:
$ a.out -x
Error: Unknown option: -x
$ a.out --help
Usage: a.out [OPTIONS]
Options:
-c, -n, --count=NUM Times to say hello. (default: 1)
--name=STRING Who to greet. (default: Unknown)
--help Show this message and exit.
$ a.out --count=2
Greeting the unknown.
Hello Unknown!
Hello Unknown!
$ a.out --name John
Hello John!All you need is:
- libs/dimcli/cli.h
- libs/dimcli/cli.cpp
Using vcpkg
- vcpkg install dimcli
Get the latest dimcli release.
Build it (this example uses Visual C++ 2022 to install a 64-bit build to c:\dimcli on a windows machine):