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

Conflicts

None