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

Conflicts

None