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. deepseek
  92. diffast-git-cli >= "0.3.5.1"
  93. diskuvbox >= "0.2.0"
  94. dkim
  95. dkim-bin
  96. dkml-install-installer
  97. dns-cli >= "10.1.0"
  98. docfd >= "13.0.0"
  99. dockerfile-cmd
  100. dockerfile-opam < "8.2.7"
  101. docteur >= "0.0.4"
  102. doctor
  103. doi2bib >= "0.7.6"
  104. dream-cli >= "0.2.0"
  105. dscheck >= "0.2.0"
  106. dune-deps >= "1.4.0"
  107. dune-release >= "2.2.0"
  108. dune_deps_extra
  109. earlybird
  110. eio-trace
  111. eio_linux >= "0.3"
  112. extism
  113. ez_cmdliner >= "0.5.0"
  114. facteur
  115. fat-filesystem < "0.13.0" | >= "0.15.1"
  116. fit >= "1.0.3"
  117. forester >= "5.0"
  118. functoria-runtime >= "4.0.0"
  119. git >= "3.2.0"
  120. git-unix >= "3.15.0"
  121. github-unix >= "4.5.0"
  122. gitlab-unix >= "0.1.3"
  123. gospel >= "0.3.1"
  124. happy-eyeballs-lwt >= "0.6.0"
  125. happy-eyeballs-miou-unix
  126. hlarp < "0.0.3"
  127. http-lwt-client >= "0.3.2"
  128. hurl >= "0.0.1~beta2"
  129. hvsock >= "3.0.1"
  130. hxd >= "0.3.5"
  131. index-bench >= "1.6.1"
  132. irmin-bench
  133. irmin-cli
  134. irmin-pack != "2.10.2"
  135. irmin-pack-tools
  136. irmin-server
  137. irmin-test >= "3.11.0"
  138. irmin-tezos
  139. irmin-unix
  140. jasmin >= "2023.06.0"
  141. js_of_ocaml-compiler >= "4.1.0"
  142. jsonschema2atd
  143. kaun-board
  144. ke >= "0.5"
  145. kmt
  146. lab >= "0.1.4"
  147. learn-ocaml
  148. learn-ocaml-client
  149. ledes
  150. letsencrypt-app
  151. MlFront_Cli < "2.3.1"
  152. MlFront_Logs
  153. MlFront_Tools
  154. markdown_monolith
  155. mastodon-archive-viewer >= "0.2"
  156. mcrunch
  157. mdx >= "2.5.1"
  158. mel
  159. melange
  160. meldep
  161. merge-fmt >= "0.3"
  162. mfat
  163. migra
  164. mirage >= "4.10.2"
  165. mirage-block-ccm
  166. mirage-logs
  167. mirage-monitoring >= "0.0.8"
  168. mirage-runtime >= "4.9.0"
  169. mirage-seal
  170. mkaudio >= "1.1.4"
  171. mlgpx
  172. mnet-cli
  173. mrmime >= "0.6.0"
  174. mtbox
  175. named-pipe
  176. nbd < "4.0.3"
  177. niru
  178. nuscr >= "2.1.0"
  179. object
  180. obuilder >= "0.4"
  181. ocamlformat >= "0.25.1"
  182. ocamlformat-lib >= "0.28.1"
  183. ocamlformat-mlx
  184. ocamlformat-mlx-lib >= "0.28.1.1"
  185. ocamlmig
  186. ocgtk
  187. ochre-cli
  188. ocluster >= "0.2"
  189. ocp-browser >= "1.2.1"
  190. ocp-indent >= "1.9.0"
  191. ocp-indent-nlfork
  192. ocp-index >= "1.4.0"
  193. odds >= "1.1"
  194. odep
  195. odig >= "0.1.0"
  196. odoc >= "3.1.0"
  197. odoc-driver
  198. odoc-md >= "3.1.0"
  199. olint
  200. omigrate >= "0.3.0"
  201. omod
  202. opam-0install >= "0.6.0"
  203. opam-0install-cudf < "0.4.1"
  204. opam-build
  205. opam-bundle
  206. opam-dune-lint
  207. opam-graph
  208. opam-grep >= "0.4.0"
  209. opam-package-upgrade
  210. opam-publish >= "3.0.0"
  211. opam-repomin
  212. opam-test
  213. opine
  214. oq
  215. orb
  216. ordma >= "0.0.5"
  217. ortac-core
  218. ortac-dune
  219. ortac-qcheck-stm
  220. ortac-wrapper
  221. osx-fsevents
  222. oui
  223. owee >= "0.8"
  224. owi >= "0.2"
  225. passage < "0.1.8" | >= "0.3.2"
  226. pds >= "5.42"
  227. pg_query >= "0.9.8"
  228. pkcs11-cli
  229. plotkicadsch < "0.9.0"
  230. polly >= "0.4.1"
  231. pplumbing < "0.0.16"
  232. ppx_deriving_cmdliner < "0.6.0"
  233. ppx_subliner
  234. ppxlib-tools
  235. prelude < "0.5"
  236. prof_spacetime
  237. prometheus-app
  238. protocol-9p < "0.12.1"
  239. protocol-9p-tool < "0.12.0" | >= "2.1.0"
  240. protocol-9p-unix < "0.12.1"
  241. pyast >= "0.2.0"
  242. pyml_bindgen >= "0.4.1"
  243. pyre-ast >= "0.1.9"
  244. qcow < "0.12.1"
  245. qmp >= "0.20.0"
  246. queenshead
  247. query-json
  248. quickterface
  249. quill
  250. randii
  251. reason >= "3.17.0"
  252. rosetta < "0.2.0"
  253. rpclib
  254. runtime_events_tools >= "0.5.4"
  255. runtime_events_tools_bare >= "0.5.4"
  256. rust-staticlib-gen
  257. salto-analyzer
  258. scfg >= "0.4"
  259. shakuhachi
  260. shared-block-ring
  261. sherlodoc != "3.1.0"
  262. slack
  263. slipshow
  264. smtml >= "0.7.0"
  265. solo5-elftool
  266. spin = "0.6.0"
  267. starred_ml >= "0.0.4"
  268. stem
  269. sun
  270. tallgeese
  271. tcpip >= "8.0.0"
  272. tensorflow
  273. testo
  274. testo-lwt
  275. tidy_email_mailgun
  276. tidy_email_sendgrid
  277. tidy_email_smtp
  278. timmy
  279. tls = "0.15.4" | >= "1.0.4"
  280. tls-lwt
  281. toc
  282. topkg-care
  283. torch < "v0.16.0"
  284. transom
  285. tuntap
  286. uring
  287. uring-trace
  288. utcp
  289. vchan < "6.0.2"
  290. vchan-unix
  291. vendredi
  292. vif
  293. wasm_of_ocaml-compiler
  294. wayland >= "1.1"
  295. webauthn
  296. webbrowser >= "0.6.2"
  297. wol-eio
  298. xapi-inventory
  299. xdge
  300. xen-evtchn
  301. xen-evtchn-unix
  302. xen-gnt
  303. yuscii = "0.2.0"

Conflicts

None