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

Authors

  1. T
    The cmdliner programmers

Maintainers

  1. Daniel Bünzli

Sources

cmdliner-2.0.0.tbz
sha512=a7bd4eeb0cef7c08bca73b0077a65f748c19a230544133b39fc3360feb2cf0af08416a8b84031c94a2f4a007d5920a4db1368d87b9eeca561671828e2dad2885

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

Conflicts

None