Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethanuppal/libcmdapp2
A simple and intuitive command line parsing library.
https://github.com/ethanuppal/libcmdapp2
command-line library parsing
Last synced: 18 days ago
JSON representation
A simple and intuitive command line parsing library.
- Host: GitHub
- URL: https://github.com/ethanuppal/libcmdapp2
- Owner: ethanuppal
- Created: 2024-01-12T06:14:03.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-12-11T00:57:57.000Z (21 days ago)
- Last Synced: 2024-12-11T01:32:39.634Z (21 days ago)
- Topics: command-line, library, parsing
- Language: C
- Homepage: http://ethanuppal.com/libcmdapp2/
- Size: 260 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overview
libcmdapp aims to be a simple and intuitive way to parse command line options and arguments.
It aims to provide flexible behavior with the least verbosity possible, intelligently filling any gaps. It is a complete replacement and successor to [libcmdapp](https://github.com/ethanuppal/libcmdapp), which I wrote over 2 years ago.
Item
Location
Documentation
cmdapp.h
Repository
https://github.com/ethanuppal/libcmdapp2
Contents
Overview
Features
Install
Example
> [!NOTE]
> The latest version of this document can be found [here](book/main.md)
# Features
This library supports
- Intuitive and succinct interface
```c
ca_author("My Name");
ca_year(2024);
ca_version(1, 0, 0);
```
- Long and short options
```c
const char* expr = "default";
ca_opt('e', "expr", ".EXPR", &expr, "evaluates an expression");
```
- Automatic `--help` and `--version` generation, `ca_print_version()`, `ca_print_help()`
```
Options:
-e, --expr[=EXPR] evaluates an expression
```
- The default implementation integrates with [`help2man`](https://www.gnu.org/software/help2man/) for __automatic man pages__
- You can override with `ca_override_help_version()`
- Error handling and option conflicts
You can read more about supplying options [here](book/opt.md).
# Install
## Unix-like (MacOS, Linux)
The following bash commands will install the library at `/usr/local/lib/` and the header files at `/usr/local/include/cmdapp/`.
```bash
git clone https://github.com/ethanuppal/libcmdapp2.git
cd libcmdapp2
sudo make install
```
You can uninstall by running
```bash
sudo make uninstall
```
from the same directory.
## Windows
The following bash commands will build the static and dynamic libraries in the `libcmdapp2/` directory.
```bash
git clone https://github.com/ethanuppal/libcmdapp2.git
cd libcmdapp2
make all
```
# Example
We'll first initialize the library.
```c
if (ca_init(argc, argv) != 0) {
perror("ca_init");
return 1;
}
```
Then, we can tell it information about our program, such as the year it was written, the authors, etc.
```c
ca_description("Serves as a useful example program for libcmdapp.");
ca_author("First Author");
ca_author("Other Author");
ca_year(2024);
ca_version(1, 0, 0);
ca_versioning_info("All rights reserved.");
```
We can also tell it how the program should be used in a series of synposes.
```c
ca_synopsis("subcommand [OPTION]...");
ca_synopsis("[OPTION]... FILE");
```
Finally, we supply the program options
```c
// options without arguments
ca_opt('a', "alert", "", NULL, "oh no!");
ca_opt('b', "very-long-name", "", NULL,
"this text has been put down a line");
// options with arguments
const char* expr = "EXPR";
ca_opt('e', "expr", ". !@f", &expr, "evaluates an expression");
const char* filename = "FILE";
ca_opt('f', "file", ". !@e", &filename, "processes a file");
// help & version
ca_opt('h', "help", "