package cmdliner

  1. Overview
  2. Docs
Declarative definition of command line interfaces for OCaml

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (4)

Authors

  1. T
    The cmdliner programmers

Maintainers

  1. Daniel Bünzli

Sources

cmdliner-1.3.0.tbz
sha512=4c46bc334444ff772637deae2f5ba03645d7a1b7db523470a1246acfce79b971c764d964cbb02388639b3161b279700d9ade95da550446fb32aa4849c8a8f283

Description

Cmdliner allows the declarative definition of command line interfaces for OCaml.

It provides a simple and compositional mechanism to convert command line arguments to OCaml values and pass them to your functions. The module automatically handles syntax errors, help messages and UNIX man page generation. It supports programs with single or multiple commands and respects most of the POSIX and GNU conventions.

Cmdliner has no dependencies and is distributed under the ISC license.

Home page: http://erratique.ch/software/cmdliner

Tags

cli system declarative org:erratique

Published: 23 May 2024

README

Cmdliner — Declarative definition of command line interfaces for OCaml

v1.3.0

Cmdliner allows the declarative definition of command line interfaces for OCaml.

It provides a simple and compositional mechanism to convert command line arguments to OCaml values and pass them to your functions. The module automatically handles syntax errors, help messages and UNIX man page generation. It supports programs with single or multiple commands and respects most of the POSIX and GNU conventions.

Cmdliner has no dependencies and is distributed under the ISC license.

Home page: http://erratique.ch/software/cmdliner

Installation

Cmdliner can be installed with opam:

opam install cmdliner

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is automatically generated by from the source interfaces. It can be consulted online or via odig doc cmdliner.

Sample programs

If you installed Cmdliner with opam sample programs are located in the directory opam config var cmdliner:doc. These programs define the command line of some classic programs.

In the distribution sample programs are located in the test directory of the distribution. They can be built and run with:

topkg build --tests true && topkg test

Dependencies (1)

  1. ocaml >= "4.08.0"

Dev Dependencies

None

  1. abella >= "2.0.8"
  2. acgtk >= "2.1.0"
  3. albatross >= "1.4.3"
  4. alcotest != "1.5.0"
  5. alcotest-async
  6. alcotest-js
  7. alcotest-lwt
  8. alcotest-mirage
  9. alt-ergo >= "2.4.2"
  10. altgr-ergo >= "2.4.2"
  11. api-watch
  12. archsat
  13. areas-and-adversaries
  14. asak >= "0.2"
  15. atd >= "2.13.0"
  16. atdcpp
  17. atdd
  18. atdpy
  19. atdts
  20. awa
  21. aws-s3
  22. b0 < "0.0.6"
  23. bap-abi < "2.2.0"
  24. bap-api < "2.2.0"
  25. bap-beagle < "2.3.0"
  26. bap-bil < "2.2.0"
  27. bap-byteweight-frontend
  28. bap-cache < "2.2.0"
  29. bap-callsites
  30. bap-demangle < "2.5.0"
  31. bap-dump-symbols < "2.2.0"
  32. bap-frames
  33. bap-frontend < "2.2.0"
  34. bap-fsi-benchmark
  35. bap-ida-plugin < "2.2.0"
  36. bap-llvm < "2.2.0"
  37. bap-main
  38. bap-objdump < "2.2.0"
  39. bap-optimization < "2.2.0"
  40. bap-phoenix
  41. bap-piqi
  42. bap-plugins < "2.2.0"
  43. bap-powerpc >= "2.2.0"
  44. bap-std
  45. bap-symbol-reader < "2.2.0"
  46. bap-taint-propagator
  47. bap-term-mapper < "2.2.0"
  48. bap-trace
  49. bap-veri
  50. bap-warn-unused
  51. bap-x86
  52. benchpress
  53. benchpress-server
  54. bentov
  55. bibfmt
  56. bisect_ppx >= "2.0.0"
  57. boltzgen
  58. boulangerie
  59. brozip
  60. builder
  61. builder-web >= "0.2.0"
  62. bytepdf
  63. ca-certs-nss
  64. caisar
  65. camels
  66. camyll
  67. capnp-rpc-unix
  68. caqti >= "1.8.0"
  69. caqti-async >= "1.8.0"
  70. caqti-driver-mariadb >= "1.8.0"
  71. caqti-driver-postgresql >= "1.8.0"
  72. caqti-driver-sqlite3 >= "1.8.0"
  73. caqti-dynload >= "2.0.1"
  74. caqti-eio
  75. caqti-lwt >= "1.8.0"
  76. caqti-miou
  77. carton >= "0.4.3" & < "1.0.0"
  78. carton-miou-unix
  79. catala >= "0.7.0"
  80. catala-format >= "0.2.0"
  81. certify >= "0.3.0"
  82. chamelon-unix
  83. charrua-unix
  84. checkseum >= "0.0.2" & < "0.2.0"
  85. clim-ppx
  86. cmdlang-cmdliner-err-runner
  87. cmdlang-to-cmdliner
  88. cmdliner-stdlib
  89. cmdtui-lambda-term
  90. cohttp-lwt-unix != "2.5.8"
  91. colibri2
  92. colibrics
  93. commons >= "1.8.0"
  94. compsort
  95. conex
  96. conex-mirage-crypto
  97. confero
  98. coq-lsp
  99. coq-serapi >= "8.9.0+0.6.0"
  100. cosovo
  101. cppffigen
  102. craml
  103. crowbar >= "0.2.1"
  104. crunch
  105. cucumber
  106. current
  107. current-albatross-deployer
  108. current_examples
  109. current_github
  110. current_gitlab
  111. current_web
  112. decompress < "1.0.0" | >= "1.3.0"
  113. dedukti >= "2.7"
  114. depgraph
  115. diffast-git-cli < "0.3.5.1"
  116. dirsift
  117. diskuvbox
  118. dkim
  119. dkim-bin
  120. dkml-component-staging-opam32 < "2.2.0~dkml20220801"
  121. dkml-component-staging-opam64 < "2.2.0~dkml20220801"
  122. dkml-install
  123. dkml-install-installer < "0.5.1"
  124. dkml-install-runner
  125. dns-cli
  126. docfd
  127. dockerfile-cmd
  128. dockerfile-opam < "8.2.7"
  129. docteur >= "0.0.4"
  130. doi2bib
  131. dolmen_bin
  132. dream-cli
  133. dryunit
  134. dscheck >= "0.2.0"
  135. dune-deps >= "1.1.0"
  136. dune-expand
  137. dune-release >= "1.6.1"
  138. dune_deps_extra
  139. earlybird
  140. eio-trace
  141. eio_linux >= "0.3"
  142. elasticsearch-cli
  143. electrod
  144. electrumAnalyzer
  145. elpi
  146. erlang
  147. extism
  148. facteur
  149. fat-filesystem
  150. fit
  151. forester >= "2.3"
  152. fsevents-lwt
  153. functoria-runtime
  154. git >= "3.2.0"
  155. git-unix >= "3.15.0"
  156. github-unix
  157. gitlab-unix >= "0.1.3"
  158. gobba
  159. gospel
  160. happy-eyeballs-lwt
  161. happy-eyeballs-miou-unix
  162. hlarp
  163. hll
  164. http-lwt-client
  165. hurl
  166. hvsock < "2.0.0" | >= "3.0.1"
  167. hxd >= "0.3.2"
  168. igvxml
  169. index >= "1.6.1"
  170. index-bench >= "1.6.1"
  171. irmin-bench
  172. irmin-cli
  173. irmin-pack != "2.10.2"
  174. irmin-pack-tools
  175. irmin-server
  176. irmin-test
  177. irmin-tezos
  178. irmin-unix
  179. jasmin >= "2023.06.0"
  180. js_of_ocaml-compiler
  181. jsonschema2atd
  182. jsonxt
  183. kafka < "0.5"
  184. kafka_lwt
  185. ke >= "0.5"
  186. kinetic-client >= "0.0.9"
  187. kmt
  188. lab
  189. labrys
  190. lambdapi != "2.1.0"
  191. learn-ocaml
  192. learn-ocaml-client
  193. ledes
  194. letsencrypt-app
  195. lilac
  196. llopt
  197. MlFront_Cli < "2.3.1"
  198. MlFront_Logs
  199. MlFront_Tools
  200. mastodon-archive-viewer
  201. mdx >= "2.2.0"
  202. mel
  203. melange
  204. meldep
  205. merge-fmt
  206. minicaml >= "0.2.2" & < "0.3.3"
  207. mirage >= "4.7.0" & < "4.10.2"
  208. mirage-block-ccm
  209. mirage-logs
  210. mirage-monitoring < "0.0.8"
  211. mirage-runtime >= "4.0.0"
  212. mirage-seal
  213. mkaudio
  214. mlgpx
  215. monorobot
  216. mrmime >= "0.5.0"
  217. mustache-cli
  218. named-pipe
  219. nbd < "4.0.3"
  220. nbd-tool
  221. niru
  222. nocoiner
  223. nuscr >= "2.0.0"
  224. obandit >= "0.3.4"
  225. obuilder
  226. ocal
  227. ocamlcodoc
  228. ocamlformat >= "0.21.0"
  229. ocamlformat-lib
  230. ocamlformat-mlx
  231. ocamlformat-mlx-lib
  232. ocamlmig
  233. ocluster >= "0.2"
  234. ocp-browser >= "1.1.7"
  235. ocp-indent
  236. ocp-indent-nlfork
  237. ocp-index
  238. ocp-reloc
  239. octez-dal-node
  240. octez-internal-libs
  241. octez-libs
  242. octez-node
  243. octez-proxy-server
  244. odds
  245. odep
  246. odig < "0.1.0"
  247. odoc
  248. odoc-driver
  249. odoc-md >= "3.1.0"
  250. ometrics
  251. omigrate
  252. omod
  253. opam-0install >= "0.4.1"
  254. opam-0install-cudf < "0.4.1"
  255. opam-build
  256. opam-bundle
  257. opam-ci
  258. opam-client
  259. opam-compiler >= "0.2.0"
  260. opam-depext >= "1.2.1"
  261. opam-devel
  262. opam-dune-lint
  263. opam-ed
  264. opam-graph
  265. opam-grep >= "0.2.0"
  266. opam-installer
  267. opam-lib
  268. opam-lock
  269. opam-package-upgrade
  270. opam-publish >= "0.3.5"
  271. opam-test
  272. opine
  273. opium
  274. orb
  275. ordma >= "0.0.5"
  276. ortac-core
  277. ortac-dune
  278. ortac-qcheck-stm
  279. ortac-wrapper
  280. orun
  281. osbx
  282. osx-fsevents
  283. owee >= "0.8"
  284. owi >= "0.2"
  285. owork
  286. passage
  287. passmakercmd
  288. pds >= "4.13"
  289. pg_query >= "0.9.6"
  290. pkcs11-cli
  291. plotkicadsch
  292. polly
  293. pplumbing < "0.0.16"
  294. ppx_deriving_cmdliner
  295. ppx_subliner
  296. ppxlib-tools
  297. prelude < "0.5"
  298. prof_spacetime
  299. prometheus-app
  300. protocol-9p < "0.12.1"
  301. protocol-9p-tool
  302. protocol-9p-unix < "0.12.1"
  303. pyast
  304. pyml_bindgen >= "0.4.1"
  305. pyre-ast
  306. qcow < "0.10.2" | = "0.11.0"
  307. qcow-tool
  308. qmp
  309. queenshead
  310. quill
  311. randii
  312. reason >= "3.17.0"
  313. regenerate
  314. rosetta < "0.2.0"
  315. rotor
  316. rpclib
  317. runtime_events_tools
  318. runtime_events_tools_bare
  319. rust-staticlib-gen
  320. salto-analyzer
  321. scfg >= "0.4"
  322. shared-block-ring
  323. sherlodoc
  324. sid
  325. slack
  326. slacko
  327. slipshow
  328. smtml
  329. solo5-elftool
  330. spin
  331. sslconf
  332. starred_ml >= "0.0.4"
  333. sun
  334. tallgeese
  335. tcpip >= "8.0.0"
  336. telltime
  337. tensorflow
  338. testo
  339. testo-lwt
  340. tezos-context-hash-irmin
  341. tidy_email_mailgun
  342. tidy_email_sendgrid
  343. tidy_email_smtp
  344. timmy
  345. tldr >= "0.3.0"
  346. tls = "0.15.4" | >= "1.0.4"
  347. tls-lwt
  348. toc
  349. topkg-care
  350. torch < "v0.16.0"
  351. touist
  352. tuntap
  353. uring
  354. uring-trace
  355. user-setup
  356. valentine
  357. vchan < "6.0.2"
  358. vchan-unix
  359. vecosek
  360. vendredi
  361. vif
  362. vpnkit
  363. wasm_of_ocaml-compiler
  364. wayland
  365. webauthn
  366. webbrowser >= "0.6.2"
  367. xapi-inventory
  368. xen-evtchn
  369. xen-evtchn-unix
  370. xen-gnt
  371. yuscii = "0.2.0"
  372. zeit

Conflicts

None