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

Conflicts

None