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 (6)

Authors

  1. T
    The cmdliner programmers

Maintainers

  1. Daniel Bünzli

Sources

cmdliner-2.1.1.tbz
sha512=cdc338ae2e56a72b7c75dae9564c57cca4e1fbfac454aabbf8303fcb612346284aede5984dfde7e8a7a496cc870bbd57ddf28cab3a38667279b31657f85c15dd

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: 22 Apr 2026

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

Conflicts

None