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-2.0.0.tbz
sha512=a7bd4eeb0cef7c08bca73b0077a65f748c19a230544133b39fc3360feb2cf0af08416a8b84031c94a2f4a007d5920a4db1368d87b9eeca561671828e2dad2885

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 command line completion, 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.

Homepage: http://erratique.ch/software/cmdliner

Tags

cli system declarative org:erratique

Published: 29 Sep 2025

README

Cmdliner — Declarative definition of command line interfaces for OCaml

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 command line completion, 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.

Homepage: 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 can be consulted online or via odig doc cmdliner.

Questions are welcome but better asked on the OCaml forum than on the issue tracker.

Sample programs

A few examples and blueprints can be found in the documentation and in the test directory.

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.9.1"
  5. alcotest-async
  6. alcotest-js
  7. alcotest-lwt
  8. alcotest-mirage
  9. altgr-ergo >= "2.4.2"
  10. api-watch
  11. areas-and-adversaries
  12. asak >= "0.2"
  13. atd >= "2.13.0"
  14. atdcpp
  15. atdd
  16. atdpy
  17. atdts
  18. awa >= "0.2.0"
  19. aws-s3
  20. b0
  21. bap-abi < "2.2.0"
  22. bap-api < "2.2.0"
  23. bap-beagle < "2.3.0"
  24. bap-bil < "2.2.0"
  25. bap-byteweight-frontend
  26. bap-cache < "2.2.0"
  27. bap-callsites
  28. bap-demangle < "2.5.0"
  29. bap-dump-symbols < "2.2.0"
  30. bap-frames
  31. bap-frontend < "2.2.0"
  32. bap-fsi-benchmark
  33. bap-ida-plugin < "2.2.0"
  34. bap-llvm < "2.2.0"
  35. bap-main < "2.2.0"
  36. bap-objdump < "2.2.0"
  37. bap-optimization < "2.2.0"
  38. bap-phoenix
  39. bap-piqi
  40. bap-plugins < "2.2.0"
  41. bap-std
  42. bap-symbol-reader < "2.2.0"
  43. bap-taint-propagator
  44. bap-term-mapper < "2.2.0"
  45. bap-trace
  46. bap-veri
  47. bap-warn-unused
  48. bap-x86 < "2.2.0"
  49. benchpress-server
  50. bibfmt
  51. boltzgen >= "0.9.5"
  52. boulangerie
  53. brozip
  54. builder
  55. builder-web >= "0.2.0"
  56. ca-certs-nss >= "3.77"
  57. caisar >= "0.2"
  58. camyll >= "0.4.1"
  59. caqti >= "1.8.0"
  60. caqti-async >= "1.8.0"
  61. caqti-driver-mariadb >= "1.8.0"
  62. caqti-driver-postgresql >= "1.8.0"
  63. caqti-driver-sqlite3 >= "1.8.0"
  64. caqti-dynload >= "2.0.1"
  65. caqti-eio
  66. caqti-lwt >= "1.8.0"
  67. caqti-miou
  68. carton >= "0.4.3" & < "1.0.0"
  69. carton-miou-unix
  70. catala >= "0.7.0"
  71. catala-format >= "0.2.0"
  72. chamelon-unix
  73. charrua-unix >= "1.6.0"
  74. checkseum = "0.0.2" | >= "0.0.9" & < "0.2.0"
  75. clim-ppx
  76. cmdlang-cmdliner-err-runner
  77. cmdlang-to-cmdliner
  78. cmdliner-stdlib
  79. cmdtui-lambda-term
  80. cohttp-lwt-unix >= "6.0.0~beta2"
  81. commons >= "1.8.0"
  82. compsort
  83. conex-mirage-crypto
  84. confero
  85. coq-lsp
  86. coq-serapi >= "8.9.0+0.6.0" & < "8.13.0+0.13.0" | >= "8.15.0+0.15.2"
  87. crowbar >= "0.2.1"
  88. crunch >= "4.0.0"
  89. cucumber
  90. current
  91. current-albatross-deployer
  92. current_examples
  93. current_github
  94. current_gitlab
  95. current_web
  96. decompress >= "1.4.3"
  97. dedukti >= "2.7"
  98. diffast-git-cli
  99. diskuvbox != "0.1.2"
  100. dkim
  101. dkim-bin
  102. dkml-component-staging-opam32 < "2.2.0~dkml20220801"
  103. dkml-component-staging-opam64 < "2.2.0~dkml20220801"
  104. dkml-install >= "0.4.0"
  105. dkml-install-installer < "0.5.1"
  106. dns-cli >= "10.1.0"
  107. dockerfile-cmd
  108. dockerfile-opam < "8.2.7"
  109. docteur >= "0.0.4"
  110. doi2bib >= "0.7.6"
  111. dream-cli >= "0.2.0"
  112. dscheck >= "0.2.0"
  113. dune-deps >= "1.4.0"
  114. dune_deps_extra
  115. earlybird
  116. eio-trace
  117. eio_linux >= "0.3"
  118. extism
  119. facteur
  120. fat-filesystem < "0.13.0" | >= "0.15.1"
  121. fit >= "1.0.3"
  122. forester >= "5.0"
  123. functoria-runtime >= "4.0.0"
  124. git >= "3.2.0"
  125. git-unix >= "3.15.0"
  126. github-unix >= "4.5.0"
  127. gitlab-unix >= "0.1.3"
  128. happy-eyeballs-lwt >= "0.6.0"
  129. happy-eyeballs-miou-unix
  130. hlarp < "0.0.3"
  131. http-lwt-client >= "0.3.2"
  132. hurl
  133. hvsock >= "3.0.1"
  134. hxd >= "0.3.5"
  135. index-bench >= "1.6.1"
  136. irmin-bench
  137. irmin-cli
  138. irmin-pack != "2.10.2"
  139. irmin-pack-tools
  140. irmin-server
  141. irmin-test >= "3.11.0"
  142. irmin-tezos
  143. irmin-unix
  144. jasmin >= "2023.06.0"
  145. js_of_ocaml-compiler >= "4.1.0"
  146. jsonschema2atd
  147. ke >= "0.5"
  148. kmt
  149. lab >= "0.1.4"
  150. labrys
  151. learn-ocaml
  152. learn-ocaml-client
  153. ledes
  154. letsencrypt-app
  155. MlFront_Cli < "2.3.1"
  156. MlFront_Logs
  157. mastodon-archive-viewer >= "0.2"
  158. mel
  159. melange
  160. meldep
  161. merge-fmt >= "0.3"
  162. mirage-block-ccm
  163. mirage-logs
  164. mirage-monitoring >= "0.0.8"
  165. mirage-runtime >= "4.9.0"
  166. mirage-seal
  167. mkaudio >= "1.1.4"
  168. mlgpx
  169. mrmime >= "0.5.0"
  170. named-pipe
  171. nbd < "4.0.3"
  172. niru
  173. nuscr >= "2.1.0"
  174. obuilder >= "0.4"
  175. ocamlformat >= "0.25.1"
  176. ocamlformat-mlx
  177. ocamlformat-mlx-lib >= "0.27.0"
  178. ocamlmig
  179. ocluster >= "0.2"
  180. ocp-browser >= "1.1.7"
  181. ocp-indent >= "1.9.0"
  182. ocp-indent-nlfork
  183. ocp-index >= "1.4.0"
  184. octez-dal-node
  185. octez-internal-libs
  186. octez-libs
  187. octez-node
  188. octez-proxy-server
  189. odds >= "1.1"
  190. odep
  191. odig >= "0.1.0"
  192. odoc >= "3.1.0"
  193. odoc-driver
  194. odoc-md >= "3.1.0"
  195. omigrate >= "0.3.0"
  196. omod
  197. opam-0install-cudf < "0.4.1"
  198. opam-build
  199. opam-bundle
  200. opam-dune-lint
  201. opam-graph
  202. opam-grep >= "0.4.0"
  203. opam-package-upgrade
  204. opam-test
  205. opine
  206. orb
  207. ordma >= "0.0.5"
  208. ortac-core
  209. ortac-dune
  210. ortac-qcheck-stm
  211. ortac-wrapper
  212. osx-fsevents
  213. owee >= "0.8"
  214. owi >= "0.2"
  215. passage
  216. pds >= "5.42"
  217. pg_query >= "0.9.8"
  218. pkcs11-cli
  219. plotkicadsch < "0.9.0"
  220. polly >= "0.4.1"
  221. pplumbing < "0.0.16"
  222. ppx_deriving_cmdliner < "0.6.0"
  223. ppx_subliner
  224. ppxlib-tools
  225. prelude < "0.5"
  226. prof_spacetime
  227. prometheus-app
  228. protocol-9p < "0.12.1"
  229. protocol-9p-tool < "0.12.0" | >= "2.1.0"
  230. protocol-9p-unix < "0.12.1"
  231. pyast >= "0.2.0"
  232. pyml_bindgen >= "0.4.1"
  233. pyre-ast >= "0.1.9"
  234. qcow < "0.10.2" | = "0.11.0"
  235. qcow-tool < "0.11.0"
  236. qmp >= "0.20.0"
  237. queenshead
  238. quill
  239. randii
  240. reason >= "3.17.0"
  241. rosetta < "0.2.0"
  242. rpclib
  243. runtime_events_tools >= "0.5.3"
  244. runtime_events_tools_bare >= "0.5.3"
  245. rust-staticlib-gen
  246. salto-analyzer
  247. scfg >= "0.4"
  248. shared-block-ring
  249. sherlodoc < "3.1.0"
  250. slack
  251. slipshow
  252. smtml >= "0.7.0"
  253. solo5-elftool
  254. spin = "0.6.0"
  255. starred_ml >= "0.0.4"
  256. sun
  257. tallgeese
  258. tcpip >= "8.0.0"
  259. tensorflow
  260. testo
  261. testo-lwt
  262. tezos-context-hash-irmin
  263. tidy_email_mailgun
  264. tidy_email_sendgrid
  265. tidy_email_smtp
  266. timmy
  267. tls = "0.15.4" | >= "1.0.4"
  268. tls-lwt
  269. toc
  270. topkg-care
  271. torch < "v0.16.0"
  272. tuntap
  273. uring
  274. uring-trace
  275. vchan < "6.0.2"
  276. vchan-unix
  277. vendredi
  278. vif
  279. vpnkit
  280. wasm_of_ocaml-compiler
  281. wayland >= "1.1"
  282. webauthn
  283. webbrowser >= "0.6.2"
  284. xapi-inventory
  285. xen-evtchn
  286. xen-evtchn-unix
  287. xen-gnt
  288. yuscii = "0.2.0"

Conflicts

None