https://github.com/objarni/basic-cmdline
Basic command line parser
https://github.com/objarni/basic-cmdline
Last synced: 3 months ago
JSON representation
Basic command line parser
- Host: GitHub
- URL: https://github.com/objarni/basic-cmdline
- Owner: objarni
- Created: 2021-09-15T09:37:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-19T06:56:39.000Z (over 4 years ago)
- Last Synced: 2025-03-31T07:15:48.161Z (about 1 year ago)
- Size: 4.88 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.txt
Awesome Lists containing this project
README
Basic command line argument parser
==================================
We want a library to help us write simple C code for parsing command line
arguments in our applications.
Must have
---------
Only one style of arguments are supported, on the form "--flag argument", e.g.
our_app --script file1.script
In this example, "script" is the key, and "file1.script" is the value.
It should be easy to determine that the parsing failed for some reason, so that
the application can write out a helpful usage text instead. Using single dash
like "-script" is an example of incorrect use.
The parser only needs to handle up to 5 of these key-value pairs, so this is an
example of using all five arguments 'slots':
our_app --log l.txt --verbose 5 --script use1.t --debug true --format JSON
Any other argument or formatting does not parse, and should be easy to handle
for the application.
Nice to have
------------
There is a popular single-letter forms of arguments, and this library does not
need to handle such; neither does "--flag=arg" style argument passing need to be
supported - but you are free to implement any as an extra exercise!
E.g these examples are 'nice to have' but not required:
-s file1.script
-s=file1.script