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

Conflicts

None