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. hurl >= "0.0.1~beta2"
  127. hvsock >= "3.0.1"
  128. hxd >= "0.3.5"
  129. index-bench >= "1.6.1"
  130. irmin-bench
  131. irmin-cli
  132. irmin-pack != "2.10.2"
  133. irmin-pack-tools
  134. irmin-server
  135. irmin-test >= "3.11.0"
  136. irmin-tezos
  137. irmin-unix
  138. jasmin >= "2023.06.0"
  139. js_of_ocaml-compiler >= "4.1.0"
  140. jsonschema2atd
  141. kaun-board
  142. ke >= "0.5"
  143. kmt
  144. lab >= "0.1.4"
  145. learn-ocaml
  146. learn-ocaml-client
  147. ledes
  148. letsencrypt-app
  149. MlFront_Cli < "2.3.1"
  150. MlFront_Logs
  151. MlFront_Tools
  152. markdown_monolith
  153. mastodon-archive-viewer >= "0.2"
  154. mcrunch
  155. mdx >= "2.5.1"
  156. mel
  157. melange
  158. meldep
  159. merge-fmt >= "0.3"
  160. mfat
  161. mirage >= "4.10.2"
  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. mnet-cli
  170. mrmime >= "0.6.0"
  171. mtbox
  172. named-pipe
  173. nbd < "4.0.3"
  174. niru
  175. nuscr >= "2.1.0"
  176. obuilder >= "0.4"
  177. ocamlformat >= "0.25.1"
  178. ocamlformat-lib >= "0.28.1"
  179. ocamlformat-mlx
  180. ocamlformat-mlx-lib >= "0.28.1.1"
  181. ocamlmig
  182. ocgtk
  183. ochre-cli
  184. ocluster >= "0.2"
  185. ocp-browser >= "1.2.1"
  186. ocp-indent >= "1.9.0"
  187. ocp-indent-nlfork
  188. ocp-index >= "1.4.0"
  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. olint
  196. omigrate >= "0.3.0"
  197. omod
  198. opam-0install >= "0.6.0"
  199. opam-0install-cudf < "0.4.1"
  200. opam-build
  201. opam-bundle
  202. opam-dune-lint
  203. opam-graph
  204. opam-grep >= "0.4.0"
  205. opam-package-upgrade
  206. opam-publish >= "3.0.0"
  207. opam-repomin
  208. opam-test
  209. opine
  210. oq
  211. orb
  212. ordma >= "0.0.5"
  213. ortac-core
  214. ortac-dune
  215. ortac-qcheck-stm
  216. ortac-wrapper
  217. osx-fsevents
  218. oui
  219. owee >= "0.8"
  220. owi >= "0.2"
  221. passage < "0.1.8" | >= "0.3.2"
  222. pds >= "5.42"
  223. pg_query >= "0.9.8"
  224. pkcs11-cli
  225. plotkicadsch < "0.9.0"
  226. polly >= "0.4.1"
  227. pplumbing < "0.0.16"
  228. ppx_deriving_cmdliner < "0.6.0"
  229. ppx_subliner
  230. ppxlib-tools
  231. prelude < "0.5"
  232. prof_spacetime
  233. prometheus-app
  234. protocol-9p < "0.12.1"
  235. protocol-9p-tool < "0.12.0" | >= "2.1.0"
  236. protocol-9p-unix < "0.12.1"
  237. pyast >= "0.2.0"
  238. pyml_bindgen >= "0.4.1"
  239. pyre-ast >= "0.1.9"
  240. qcow < "0.12.1"
  241. qmp >= "0.20.0"
  242. queenshead
  243. query-json
  244. quickterface
  245. quill
  246. randii
  247. reason >= "3.17.0"
  248. rosetta < "0.2.0"
  249. rpclib
  250. runtime_events_tools >= "0.5.4"
  251. runtime_events_tools_bare >= "0.5.4"
  252. rust-staticlib-gen
  253. salto-analyzer
  254. scfg >= "0.4"
  255. shakuhachi
  256. shared-block-ring
  257. sherlodoc < "3.1.0"
  258. slack
  259. slipshow
  260. smtml >= "0.7.0"
  261. solo5-elftool
  262. spin = "0.6.0"
  263. starred_ml >= "0.0.4"
  264. stem
  265. sun
  266. tallgeese
  267. tcpip >= "8.0.0"
  268. tensorflow
  269. testo
  270. testo-lwt
  271. tidy_email_mailgun
  272. tidy_email_sendgrid
  273. tidy_email_smtp
  274. timmy
  275. tls = "0.15.4" | >= "1.0.4"
  276. tls-lwt
  277. toc
  278. topkg-care
  279. torch < "v0.16.0"
  280. tuntap
  281. uring
  282. uring-trace
  283. utcp
  284. vchan < "6.0.2"
  285. vchan-unix
  286. vendredi
  287. vif
  288. wasm_of_ocaml-compiler
  289. wayland >= "1.1"
  290. webauthn
  291. webbrowser >= "0.6.2"
  292. wol-eio
  293. xapi-inventory
  294. xdge
  295. xen-evtchn
  296. xen-evtchn-unix
  297. xen-gnt
  298. yuscii = "0.2.0"

Conflicts

None