Skip to content

Paulanerus/ArgParser

Repository files navigation

ArgParser

ArgParser is a simple, single header-only C++17 library to parse command like input. Similar in functionality to tools like cargo, the Rust package manager. It started as a testing project and after some development I thought that someone could use this as well.

This library was tested on Windows (MSCV) and GNU/Linux (GCC, Clang), with additional checking on GNU/Linux with Valgrind

Examples

Example 1:

#include "arg_parser.hpp"

int main(int argc, char* argv[])
{
    psap::ArgParser parser{
        psap::ParserConf{"project_name", 4, true, psap::ValueStyle::Both}};

    auto HELP_ACTION = 
        [](const psap::ArgParser &parser, const psap::Command &cmd)
        {
            parser(parser[0]); // Print info text of remaining args
        }

    parser.command("help", "h")
        .help("Shows help.")
        .action(HELP_ACTION);

    //More commands to come

    parser.parse(argv, argc);
}

Output:

Usage: project_name [Command] [Options]

Commands:
    help, h    Shows help.

See 'project_name help <command>' for more information on a specific command.

Example 2:

    psap::ArgParser parser{
        psap::ParserConf{"project_name", 4, true, psap::ValueStyle::Both}};

    auto RUN_ACTION = 
        [](const psap::ArgParser &parser, const psap::Command &cmd)
        {
            //Run action...
        }

    parser.command("run", "r")
        .help("Runs something.")
        .option(Option::Value({"--target", "-t"}, "Select a Target."))
        .option(Option::Flag({"--debug", "-d"}, "Runs in debug."))
        .action(RUN_ACTION);

    //More commands to come

    parser.parse(argv, argc);

Documentation

Documentation can be found in the wiki pages.

Dependencies

ArgParser has no other dependencies.

Support

If you encounter any issues or have any questions about this project, don't hesitate to reach out to me. You can open an issue on GitHub.