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 (5)

Authors

  1. T
    The cmdliner programmers

Maintainers

  1. Daniel Bünzli

Sources

cmdliner-2.1.0.tbz
sha512=2ca8c9a2b392e031f88aa0e76f2ab50c8e9e28d77852d04ca2d5b62326630ca41567ce0832e9a9334d9b130b48deede66c7880a9d0aee75a1afe7541097e249f

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: 26 Nov 2025

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. ocluster >= "0.2"
  197. ocp-browser >= "1.1.7"
  198. ocp-indent >= "1.9.0"
  199. ocp-indent-nlfork
  200. ocp-index >= "1.4.0"
  201. odds >= "1.1"
  202. odep
  203. odig >= "0.1.0"
  204. odoc >= "3.1.0"
  205. odoc-driver
  206. odoc-md >= "3.1.0"
  207. olint
  208. omigrate >= "0.3.0"
  209. omod
  210. opam-0install-cudf < "0.4.1"
  211. opam-build
  212. opam-bundle
  213. opam-dune-lint
  214. opam-graph
  215. opam-grep >= "0.4.0"
  216. opam-package-upgrade
  217. opam-publish >= "3.0.0"
  218. opam-repomin
  219. opam-test
  220. opine
  221. oq
  222. orb
  223. ordma >= "0.0.5"
  224. ortac-core
  225. ortac-dune
  226. ortac-qcheck-stm
  227. ortac-wrapper
  228. osx-fsevents
  229. oui
  230. owee >= "0.8"
  231. owi >= "0.2"
  232. passage < "0.1.8" | >= "0.3.2"
  233. pds >= "5.42"
  234. pg_query >= "0.9.8"
  235. pkcs11-cli
  236. plotkicadsch < "0.9.0"
  237. polly >= "0.4.1"
  238. pplumbing < "0.0.16"
  239. ppx_deriving_cmdliner < "0.6.0"
  240. ppx_subliner
  241. ppxlib-tools
  242. prelude < "0.5"
  243. prof_spacetime
  244. prometheus-app
  245. protocol-9p < "0.12.1"
  246. protocol-9p-tool < "0.12.0" | >= "2.1.0"
  247. protocol-9p-unix < "0.12.1"
  248. pyast >= "0.2.0"
  249. pyml_bindgen >= "0.4.1"
  250. pyre-ast >= "0.1.9"
  251. qcow < "0.10.2" | = "0.11.0"
  252. qcow-tool < "0.11.0"
  253. qmp >= "0.20.0"
  254. queenshead
  255. query-json
  256. quickterface
  257. quill
  258. randii
  259. reason >= "3.17.0"
  260. rosetta < "0.2.0"
  261. rpclib
  262. runtime_events_tools >= "0.5.4"
  263. runtime_events_tools_bare >= "0.5.4"
  264. rust-staticlib-gen
  265. salto-analyzer
  266. scfg >= "0.4"
  267. shakuhachi
  268. shared-block-ring
  269. sherlodoc < "3.1.0"
  270. slack
  271. slipshow
  272. smtml >= "0.7.0"
  273. solo5-elftool
  274. spin = "0.6.0"
  275. starred_ml >= "0.0.4"
  276. sun
  277. tallgeese
  278. tcpip >= "8.0.0"
  279. tensorflow
  280. testo
  281. testo-lwt
  282. tidy_email_mailgun
  283. tidy_email_sendgrid
  284. tidy_email_smtp
  285. timmy
  286. tls = "0.15.4" | >= "1.0.4"
  287. tls-lwt
  288. toc
  289. topkg-care
  290. torch < "v0.16.0"
  291. tuntap
  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. wayland >= "1.1"
  301. webauthn
  302. webbrowser >= "0.6.2"
  303. xapi-inventory
  304. xdge
  305. xen-evtchn
  306. xen-evtchn-unix
  307. xen-gnt
  308. yuscii = "0.2.0"

Conflicts

None