Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oliverdelancey/clapfn
A fast and simple command line argument parser for Nim
https://github.com/oliverdelancey/clapfn
Last synced: 6 days ago
JSON representation
A fast and simple command line argument parser for Nim
- Host: GitHub
- URL: https://github.com/oliverdelancey/clapfn
- Owner: oliverdelancey
- License: mit
- Created: 2020-09-26T21:19:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-02T22:00:09.000Z (6 months ago)
- Last Synced: 2024-12-14T15:05:28.532Z (about 1 month ago)
- Language: Nim
- Size: 28.3 KB
- Stars: 15
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cli-frameworks - clapfn
README
# clapfn
[![Language](https://img.shields.io/badge/language-nim-yellow?style=flat-square&logo=nim")](https://nim-lang.org/)
[![Nimble](https://img.shields.io/badge/nimble%20repo-clapfn-yellowgreen?style=flat-square&")](https://nimble.directory/pkg/clapfn)
[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square&logo=github")](https://github.com/oliverdelancey/clapfn/blob/master/LICENSE")
`clapfn` is an easy-to-use **C**ommand **L**ine **A**rgument **P**arser **F**or **N**im.
Please contact me if you have any issues using this library. This library is actively
maintained and supported; I haven't made any commits lately simply because this project
seems to be stable. But feel free to contact me via an issue, and I will see what I can
do!
## Installation
Installing is as simple as:
```bash
nimble install clapfn
```
## Usage
`clapfn` is specifically designed to be straightforward to work with.
```nim
import tables
import clapfn
var parser = ArgumentParser(programName: "mcp", fullName: "My Cool Program",
description: "A test program.", version: "0.0.0",
author: "An Author ")
# See the wiki for in-depth documentation, especially the purposes
# of the various parameters.
# It is not necessary to use the argument names; they are here
# simply for explanation. *All* function arguments are required.
parser.addRequiredArgument(name="in_file", help="Input file.")
parser.addStoreArgument(shortName="-o", longName="--out", usageInput="output",
default="out.file", help="Specify the output file.")
parser.addSwitchArgument(shortName="-d", longName="--debug", default=false,
help="Enable debug printing.")
let args = parser.parse()
echo args["in_file"]
echo args["out"]
echo args["debug"]
```
And if you were to run `mcp --help`:
```
My Cool Program v0.0.0
An Author
A test program.
Usage: mcp [-h] [-v] [-o output] [-d] in_file
Required arguments:
in_file Input file.
Optional arguments:
-h, --help Show this help message and exit.
-v, --version Show version number and exit.
-o=output, --out=output Specify the output file.
-d, --debug Enable debug printing.
```
`clapfn` uses Nim's default delimiter style:
```bash
# good
-o:output
-o=output
# BAD
-o output
```
The values of the command line arguments are stored in a [Table](https://nim-lang.org/docs/tables.html), and can be accessed thus:
```nim
args["in_file"]
args["out"]
args["debug"]
# etc
```
See `example.nim` for a fully functional example.
## Documentation
See the [wiki](https://github.com/oliverdelancey/clapfn/wiki) for documentation.
## License
This project uses the [MIT License](https://github.com/oliverdelancey/clapfn/blob/master/LICENSE)
## Contact
Raise an Issue! I'll see you there.
Project link: [https://github.com/oliverdelancey/clapfn](https://github.com/oliverdelancey/clapfn)