Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mpeterv/argparse
Feature-rich command line parser for Lua
https://github.com/mpeterv/argparse
Last synced: about 2 months ago
JSON representation
Feature-rich command line parser for Lua
- Host: GitHub
- URL: https://github.com/mpeterv/argparse
- Owner: mpeterv
- License: mit
- Created: 2013-12-30T14:26:42.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-11-25T07:19:23.000Z (over 3 years ago)
- Last Synced: 2024-01-08T20:11:18.274Z (6 months ago)
- Language: Lua
- Size: 621 KB
- Stars: 235
- Watchers: 16
- Forks: 40
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-lua - argparse - A feature-rich command line parser inspired by argparse for Python. (Resources / Command-line Utilities)
- awesome-lua-zh - argparse - A feature-rich command line parser inspired by argparse for Python. (资源 / Command-line Utilities)
README
# argparse
[](https://travis-ci.org/mpeterv/argparse)
[](https://codecov.io/gh/mpeterv/argparse)
Argparse is a feature-rich command line parser for Lua inspired by argparse for Python.
Argparse supports positional arguments, options, flags, optional arguments, subcommands and more. Argparse automatically generates usage, help and error messages.
## Contents
* [Example](#example)
* [Installation](#installation)
* [Tutorial](#tutorial)
* [Testing](#testing)
* [License](#license)
## Example
Simple example:
```lua
-- script.lua
local argparse = require "argparse"
local parser = argparse("script", "An example.")
parser:argument("input", "Input file.")
parser:option("-o --output", "Output file.", "a.out")
parser:option("-I --include", "Include locations."):count("*")
local args = parser:parse()
```
`args` contents depending on command line arguments:
```bash
$ lua script.lua foo
```
```lua
{
input = "foo",
output = "a.out",
include = {}
}
```
```bash
$ lua script.lua foo -I/usr/local/include -Isrc -o bar
```
```lua
{
input = "foo",
output = "bar",
include = {"/usr/local/include", "src"}
}
```
Error messages depending on command line arguments:
```bash
$ lua script.lua foo bar
```
```
Usage: script [-o ] [-I ] [-h]
Error: too many arguments
```
```bash
$ lua script.lua --help
```
```
Usage: script [-o ] [-I ] [-h]
An example.
Arguments:
input Input file.
Options:
-o , --output
Output file. (default: a.out)
-I , --include
Include locations.
-h, --help Show this help message and exit.
```
```bash
$ lua script.lua foo --outptu=bar
```
```
Usage: script [-o ] [-I ] [-h]
Error: unknown option '--outptu'
Did you mean '--output'?
```
## Installation
### Using LuaRocks
Installing argparse using [LuaRocks](http://luarocks.org) is simple:
```bash
$ luarocks install argparse
```
### Without LuaRocks
Download `src/argparse.lua` file and put it into the directory for Lua libraries or your working directory.
## Tutorial
The tutorial is available [online](http://argparse.readthedocs.org). If argparse has been installed using LuaRocks 2.1.2 or later, it can be viewed using `luarocks doc argparse` command.
Tutorial HTML files can be built using [Sphinx](http://sphinx-doc.org/): `sphinx-build docsrc doc`, the files will be found inside `doc/`.
## Testing
argparse comes with a testing suite located in `spec` directory. [busted](http://olivinelabs.com/busted/) is required for testing, it can be installed using LuaRocks. Run the tests using `busted` command from the argparse folder.
## License
argparse is licensed under the same terms as Lua itself (MIT license).