https://github.com/cofyc/argparse

Command-line arguments parsing library.
https://github.com/cofyc/argparse

argparse argument-parsing c cli

Last synced: 4 days ago
JSON representation

Command-line arguments parsing library.

• Host: GitHub
• URL: https://github.com/cofyc/argparse
• Owner: cofyc
• License: mit
• Created: 2012-03-10T11:05:34.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-07-15T02:10:57.000Z (5 months ago)
• Last Synced: 2024-12-13T08:03:44.055Z (11 days ago)
• Topics: argparse, argument-parsing, c, cli
• Language: C
• Homepage:
• Size: 123 KB
• Stars: 693
• Watchers: 27
• Forks: 125
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# argparse

[![Build Status](https://github.com/cofyc/argparse/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/cofyc/argparse/actions/workflows/ci.yaml)

argparse - A command line arguments parsing library in C (compatible with C++).

## Description

This module is inspired by parse-options.c (git) and python's argparse

module.

Arguments parsing is common task in cli program, but traditional `getopt`

libraries are not easy to use. This library provides high-level arguments

parsing solutions.

The program defines what arguments it requires, and `argparse` will figure

out how to parse those out of `argc` and `argv`, it also automatically

generates help and usage messages and issues errors when users give the

program invalid arguments.

## Features

 - handles both optional and positional arguments

 - produces highly informative usage messages

 - issues errors when given invalid arguments

There are basically three types of options:

 - boolean options

 - options with mandatory argument

 - options with optional argument

There are basically two forms of options:

 - short option consist of one dash (`-`) and one alphanumeric character.

 - long option begin with two dashes (`--`) and some alphanumeric characters.

Short options may be bundled, e.g. `-a -b` can be specified as `-ab`.

Options are case-sensitive.

Options and non-option arguments can clearly be separated using the `--` option.

## Examples

- [basic](tests/basic.c)

- [subcommands](tests/subcommands.c)