cleopter

#+TITLE: cleopter

A minimalist command-line parser written in portable Common Lisp.

=cleopter= lets you define command-line options using a simple, declarative
syntax.  That specification is then used to parse command-line arguments, and
generate =--help=.

Tested on SBCL, CCL, ECL, ABCL, CLISP and Clasp.

Zero dependencies (even for the test suite).

* Example

See the [[file:example/][example folder]] for a complete demonstration that builds a standalone
executable with a fully-featured command-line interface.

The =cleopter/example= system (see [[file:cleopter.asd::19][cleopter.asd]]) specifies the path and entry
point of the executable, which can be generated via =make build-example=.

Once built, try the invocations below:

#+begin_src bash
./example/bin/example --help
./example/bin/example --foo     # Raises an error.
./example/bin/example -v        # Raises an error.
./example/bin/example -v "foo"  # Raises an error.
./example/bin/example -v 5
./example/bin/example --eval '(defvar foo 1)' \
                      --eval '(setf foo 2)' \
                      --eval '(format t "foo: ~a~%" foo)'
#+end_src

See [[file:example/example.lisp][example/example.lisp]] for implementation details.

* Acknowledgments
This work was partly funded by [[https://www.bounce-commerce.de/en/][Bounce Commerce GmbH]].

* References and related projects
https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap12.html

- [[https://github.com/sjl/adopt/][adopt]]
- [[https://github.com/pve1/apply-argv][apply-argv]]
- [[https://github.com/epuccini/argparse][argparse]]
- [[https://github.com/vigneshsarma/clap][clap]]
- [[https://github.com/simkoc/cl-argparse][cl-argparse]]
- [[https://github.com/renard/cl-cli][cl-cli]]
- [[https://github.com/ghollisjr/cl-getopt][cl-getopt]]
- [[https://github.com/djha-skin/cliff][cliff]]
- [[https://github.com/dnaeon/clingon][clingon]]
- [[https://github.com/tlikonen/cl-just-getopt-parser][cl-just-getopt-parser]]
- [[https://github.com/didierverna/clon][clon]]
- [[https://git.sr.ht/~whereiseveryone/command-line-args][command-line-args]]
- [[https://github.com/fare/command-line-arguments][command-line-arguments]]
- [[https://github.com/shamazmazum/command-line-parse][command-line-parse]]
- [[https://github.com/liquidz/corne][corne]]
- [[https://github.com/40ants/defmain][defmain]]
- [[https://github.com/brown/lisp-gflags][lisp-gflags]]
- [[https://github.com/wmarvel/net-wmarvel-argv-parser][net-wmarvel-argv-parser]]
- [[https://github.com/salvipeter/parse-args][parse-args]]
- [[https://github.com/m-e-leypold/romulan][romulan]]
- [[https://github.com/astine/unix-options][unix-options]]
- [[https://github.com/libre-man/unix-opts][unix-opts]]

# Python libraries
# https://docs.python.org/3/library/optparse.html
# https://docs.python.org/3/library/argparse.html

# http://docopt.org/

# Haskell libraries
# https://github.com/pcapriotti/optparse-applicative
# https://github.com/ndmitchell/cmdargs


cleopter

Upstream URL

Author

License

cleopter

Version:

License:

Authors:

Dependencies:

cleopter/example

Dependencies:

cleopter/tests

Dependencies:

Dependencies (0)

Dependents (0)