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. migra
  162. mirage >= "4.10.2"
  163. mirage-block-ccm
  164. mirage-logs
  165. mirage-monitoring >= "0.0.8"
  166. mirage-runtime >= "4.9.0"
  167. mirage-seal
  168. mkaudio >= "1.1.4"
  169. mlgpx
  170. mnet-cli
  171. mrmime >= "0.6.0"
  172. mtbox
  173. named-pipe
  174. nbd < "4.0.3"
  175. niru
  176. nuscr >= "2.1.0"
  177. object
  178. obuilder >= "0.4"
  179. ocamlformat >= "0.25.1"
  180. ocamlformat-lib >= "0.28.1"
  181. ocamlformat-mlx
  182. ocamlformat-mlx-lib >= "0.28.1.1"
  183. ocamlmig
  184. ocgtk
  185. ochre-cli
  186. ocluster >= "0.2"
  187. ocp-browser >= "1.2.1"
  188. ocp-indent >= "1.9.0"
  189. ocp-indent-nlfork
  190. ocp-index >= "1.4.0"
  191. odds >= "1.1"
  192. odep
  193. odig >= "0.1.0"
  194. odoc >= "3.1.0"
  195. odoc-driver
  196. odoc-md >= "3.1.0"
  197. olint
  198. omigrate >= "0.3.0"
  199. omod
  200. opam-0install >= "0.6.0"
  201. opam-0install-cudf < "0.4.1"
  202. opam-build
  203. opam-bundle
  204. opam-dune-lint
  205. opam-graph
  206. opam-grep >= "0.4.0"
  207. opam-package-upgrade
  208. opam-publish >= "3.0.0"
  209. opam-repomin
  210. opam-test
  211. opine
  212. oq
  213. orb
  214. ordma >= "0.0.5"
  215. ortac-core
  216. ortac-dune
  217. ortac-qcheck-stm
  218. ortac-wrapper
  219. osx-fsevents
  220. oui
  221. owee >= "0.8"
  222. owi >= "0.2"
  223. passage < "0.1.8" | >= "0.3.2"
  224. pds >= "5.42"
  225. pg_query >= "0.9.8"
  226. pkcs11-cli
  227. plotkicadsch < "0.9.0"
  228. polly >= "0.4.1"
  229. pplumbing < "0.0.16"
  230. ppx_deriving_cmdliner < "0.6.0"
  231. ppx_subliner
  232. ppxlib-tools
  233. prelude < "0.5"
  234. prof_spacetime
  235. prometheus-app
  236. protocol-9p < "0.12.1"
  237. protocol-9p-tool < "0.12.0" | >= "2.1.0"
  238. protocol-9p-unix < "0.12.1"
  239. pyast >= "0.2.0"
  240. pyml_bindgen >= "0.4.1"
  241. pyre-ast >= "0.1.9"
  242. qcow < "0.12.1"
  243. qmp >= "0.20.0"
  244. queenshead
  245. query-json
  246. quickterface
  247. quill
  248. randii
  249. reason >= "3.17.0"
  250. rosetta < "0.2.0"
  251. rpclib
  252. runtime_events_tools >= "0.5.4"
  253. runtime_events_tools_bare >= "0.5.4"
  254. rust-staticlib-gen
  255. salto-analyzer
  256. scfg >= "0.4"
  257. shakuhachi
  258. shared-block-ring
  259. sherlodoc != "3.1.0"
  260. slack
  261. slipshow
  262. smtml >= "0.7.0"
  263. solo5-elftool
  264. spin = "0.6.0"
  265. starred_ml >= "0.0.4"
  266. stem
  267. sun
  268. tallgeese
  269. tcpip >= "8.0.0"
  270. tensorflow
  271. testo
  272. testo-lwt
  273. tidy_email_mailgun
  274. tidy_email_sendgrid
  275. tidy_email_smtp
  276. timmy
  277. tls = "0.15.4" | >= "1.0.4"
  278. tls-lwt
  279. toc
  280. topkg-care
  281. torch < "v0.16.0"
  282. transom
  283. tuntap
  284. uring
  285. uring-trace
  286. utcp
  287. vchan < "6.0.2"
  288. vchan-unix
  289. vendredi
  290. vif
  291. wasm_of_ocaml-compiler
  292. wayland >= "1.1"
  293. webauthn
  294. webbrowser >= "0.6.2"
  295. wol-eio
  296. xapi-inventory
  297. xdge
  298. xen-evtchn
  299. xen-evtchn-unix
  300. xen-gnt
  301. yuscii = "0.2.0"

Conflicts

None