Home

Awesome

SysCmdLine

C++ Advanced Command Line Parser.

Inspired by Qt QCommandLineParser and C# System.CommandLine.

Introduction

To be in line with the principle of "don't learn anything new if you don't need to", on the one hand, syscmdline contains as many common features as possible, on the other hand, it's simple enough to be easy to understand.

Therefore, the project is designed to be configurable, but it's not intended to be as complex as a framework.

Features

<!-- ## Help Text The help text is highly configurable, here we show some simple ones. ### Unix Style ``` Description: Move source(s) to destination directory. Usage: mv <src>... <dest> [options] Arguments: src Source(s) dest Destination directory Options: -v, --version Show version information -h, --help Show help information ``` ### Dos Style ``` Description: Deletes one or more files. Usage: del files... [/P] [/F] [/S] [/Q] [/?] Arguments: files Specifies a list of one or more files or directories. Options: /P Prompts for confirmation before deleting the specified file. /F Forces deletion of read-only files. /S Deletes specified files from the current directory and all subdirectories. /Q Specifies quiet mode. You are not prompted for delete confirmation. /? Show help information. ``` -->

Simple Example

A simple mv command:

#include <iostream>
#include <syscmdline/parser.h>

namespace SCL = SysCmdLine;

int main(int argc, char *argv[]) {
    SCL::Command cmd("mv", "move files to directory");
    cmd.addArguments({
        SCL::Argument("files", "Source files").multi(),
        SCL::Argument("dir", "Destination directory"),
    });
    cmd.addHelpOption();
    cmd.setHandler([](const SCL::ParseResult &result) -> int {
        std::cout << "[Sources]" << std::endl;
        for (const auto &item : result.values("files")) {
            std::cout << item.toString() << std::endl;
        }
        std::cout << "[Destination]" << std::endl;
        std::cout <<  result.value("dir").toString() << std::endl;
        return 0;
    });
    return SCL::Parser(cmd).invoke(argc, argv);
}

Running the code:

> ./mv --help
Description:
    move files to directory

Usage:
    mv <files>... <dir> [options]

Arguments:
    <files>    Source files
    <dir>      Destination directory

Options:
    -h, --help    Show help information

> ./mv 1 2
[Sources]
1
[Destination]
2

>./mv 1 2 3
[Sources]
1        
2        
[Destination]
3

Quick Start

Concepts

If you are confused about some of the concepts of command line programs, you can learn the following, which will help you use this project.

See Concepts to learn more.

More Examples

See Examples to learn more.

CMake Intergration

Build & Install

cmake -B build -G Ninja
cmake --build build --target all
cmake --build build --target install

Import

find_package(syscmdline REQUIRED)
target_link_libraries(my_project PRIVATE syscmdline::syscmdline)

Notice

<!-- + C++ Standard + You need a C++ compiler which supports C++17 to build the library. The interface is compatible with C++11. -->

Thanks

Other Projects

<!-- + https://github.com/tanakh/cmdline + https://github.com/p-ranav/argparse + https://github.com/CLIUtils/CLI11 -->

Contributors

License

This project is licensed under the MIT License.