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" & < "6.0"
  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. cascade
  60. catala >= "0.7.0"
  61. catala-format >= "0.2.0"
  62. chamelon-unix
  63. charrua-unix >= "1.6.0"
  64. checkseum = "0.0.2" | >= "0.0.9" & < "0.2.0"
  65. ciao_lwt
  66. clim-ppx
  67. cmdlang-cmdliner-err-runner
  68. cmdlang-to-cmdliner
  69. cmdliner-stdlib
  70. cmdtui-lambda-term
  71. cohttp-curl-lwt >= "6.2.1"
  72. cohttp-lwt-unix >= "6.0.0~beta2"
  73. commons >= "1.8.0"
  74. compsort
  75. conex >= "1.0.0"
  76. conex-mirage-crypto
  77. confero
  78. coq-lsp
  79. coq-serapi < "8.13.0+0.13.0" | >= "8.15.0+0.15.2"
  80. crockford
  81. crowbar >= "0.2.1"
  82. crunch >= "4.0.0"
  83. cucumber
  84. current
  85. current-albatross-deployer
  86. current_examples
  87. current_github
  88. current_gitlab
  89. current_web
  90. decompress >= "1.4.3"
  91. dedukti >= "2.7"
  92. deepseek
  93. diffast-git-cli >= "0.3.5.1"
  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. menhirformat
  162. merge-fmt >= "0.3"
  163. mfat
  164. migra
  165. mirage >= "4.10.2"
  166. mirage-block-ccm
  167. mirage-logs
  168. mirage-monitoring >= "0.0.8"
  169. mirage-runtime >= "4.9.0"
  170. mirage-seal
  171. mkaudio >= "1.1.4"
  172. mlgpx
  173. mnet-cli
  174. mrmime >= "0.6.0"
  175. mtbox
  176. named-pipe
  177. nbd < "4.0.3"
  178. niru
  179. nuscr >= "2.1.0"
  180. object
  181. obuilder >= "0.4"
  182. ocamlformat >= "0.25.1"
  183. ocamlformat-lib >= "0.28.1"
  184. ocamlformat-mlx
  185. ocamlformat-mlx-lib >= "0.28.1.1"
  186. ocamlgrep
  187. ocamlmig
  188. ocgtk < "0.1~preview2"
  189. ochre-cli
  190. ocluster >= "0.2"
  191. ocp-browser >= "1.2.1"
  192. ocp-indent >= "1.9.0"
  193. ocp-indent-nlfork
  194. ocp-index >= "1.4.0"
  195. ocsigen-toolkit >= "4.3.0"
  196. odds >= "1.1"
  197. odep
  198. odig >= "0.1.0"
  199. odoc >= "3.1.0"
  200. odoc-driver
  201. odoc-md >= "3.1.0"
  202. olint
  203. omigrate >= "0.3.0"
  204. omod
  205. opam-0install >= "0.6.0"
  206. opam-0install-cudf < "0.4.1"
  207. opam-build
  208. opam-bundle
  209. opam-dune-lint
  210. opam-graph
  211. opam-grep >= "0.4.0"
  212. opam-minver
  213. opam-package-upgrade
  214. opam-publish >= "3.0.0"
  215. opam-repomin
  216. opam-test
  217. opine
  218. oq
  219. orb
  220. ordma >= "0.0.5"
  221. ortac-core
  222. ortac-dune
  223. ortac-qcheck-stm
  224. ortac-wrapper
  225. osx-fsevents
  226. oui
  227. owee >= "0.8"
  228. owi >= "0.2"
  229. passage < "0.1.8" | >= "0.3.2"
  230. pds >= "5.42"
  231. pg_query >= "0.9.8"
  232. pkcs11-cli
  233. plotkicadsch < "0.9.0"
  234. polly >= "0.4.1"
  235. pplumbing < "0.0.16"
  236. ppx_deriving_cmdliner < "0.6.0"
  237. ppx_subliner
  238. ppxlib-tools
  239. prelude < "0.5"
  240. prof_spacetime
  241. prometheus-app
  242. protocol-9p < "0.12.1"
  243. protocol-9p-tool < "0.12.0" | >= "2.1.0"
  244. protocol-9p-unix < "0.12.1"
  245. pyast >= "0.2.0"
  246. pyml_bindgen >= "0.4.1"
  247. pyre-ast >= "0.1.9"
  248. qcow < "0.12.1"
  249. qmp >= "0.20.0"
  250. queenshead
  251. query-json
  252. quickterface
  253. quill
  254. randii
  255. reason >= "3.17.0"
  256. rosetta < "0.2.0"
  257. rpclib
  258. runtime_events_tools >= "0.5.4"
  259. runtime_events_tools_bare >= "0.5.4"
  260. rust-staticlib-gen
  261. salto-analyzer
  262. scfg >= "0.4"
  263. shakuhachi
  264. shared-block-ring
  265. sherlodoc != "3.1.0"
  266. slack
  267. slipshow
  268. smtml >= "0.7.0"
  269. solo5-elftool
  270. soteria
  271. spin = "0.6.0"
  272. starred_ml >= "0.0.4"
  273. stem
  274. sun
  275. tallgeese
  276. tcpip >= "8.0.0"
  277. tensorflow
  278. testo
  279. testo-lwt
  280. tidy_email_mailgun
  281. tidy_email_sendgrid
  282. tidy_email_smtp
  283. timmy
  284. tls = "0.15.4" | >= "1.0.4"
  285. tls-lwt
  286. toc
  287. topkg-care
  288. torch < "v0.16.0"
  289. transom
  290. tuntap
  291. tw
  292. uring
  293. uring-trace
  294. utcp
  295. vchan < "6.0.2"
  296. vchan-unix
  297. vendredi
  298. vif
  299. wasm_of_ocaml-compiler
  300. wax
  301. wayland >= "1.1"
  302. webauthn
  303. webbrowser >= "0.6.2"
  304. wol-eio
  305. xapi-inventory
  306. xdge
  307. xen-evtchn
  308. xen-evtchn-unix
  309. xen-gnt
  310. yuscii = "0.2.0"

Conflicts

None