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

Conflicts

None