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 >= "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. hurl
  135. hvsock >= "3.0.1"
  136. hxd >= "0.3.5"
  137. index-bench >= "1.6.1"
  138. irmin-bench
  139. irmin-cli
  140. irmin-pack != "2.10.2"
  141. irmin-pack-tools
  142. irmin-server
  143. irmin-test >= "3.11.0"
  144. irmin-tezos
  145. irmin-unix
  146. jasmin >= "2023.06.0"
  147. js_of_ocaml-compiler >= "4.1.0"
  148. jsonschema2atd
  149. ke >= "0.5"
  150. kmt
  151. lab >= "0.1.4"
  152. labrys
  153. learn-ocaml
  154. learn-ocaml-client
  155. ledes
  156. letsencrypt-app
  157. MlFront_Cli < "2.3.1"
  158. MlFront_Logs
  159. MlFront_Tools
  160. mastodon-archive-viewer >= "0.2"
  161. mdx >= "2.5.1"
  162. mel
  163. melange
  164. meldep
  165. merge-fmt >= "0.3"
  166. mirage >= "4.10.2"
  167. mirage-block-ccm
  168. mirage-logs
  169. mirage-monitoring >= "0.0.8"
  170. mirage-runtime >= "4.9.0"
  171. mirage-seal
  172. mkaudio >= "1.1.4"
  173. mlgpx
  174. mrmime >= "0.6.0"
  175. named-pipe
  176. nbd < "4.0.3"
  177. niru
  178. nuscr >= "2.1.0"
  179. obuilder >= "0.4"
  180. ocamlformat >= "0.25.1"
  181. ocamlformat-lib >= "0.28.1"
  182. ocamlformat-mlx
  183. ocamlmig
  184. ocluster >= "0.2"
  185. ocp-browser >= "1.1.7"
  186. ocp-indent >= "1.9.0"
  187. ocp-indent-nlfork
  188. ocp-index >= "1.4.0"
  189. octez-dal-node
  190. octez-internal-libs
  191. octez-libs
  192. octez-node
  193. octez-proxy-server
  194. odds >= "1.1"
  195. odep
  196. odig >= "0.1.0"
  197. odoc >= "3.1.0"
  198. odoc-driver
  199. odoc-md >= "3.1.0"
  200. omigrate >= "0.3.0"
  201. omod
  202. opam-0install-cudf < "0.4.1"
  203. opam-build
  204. opam-bundle
  205. opam-dune-lint
  206. opam-graph
  207. opam-grep >= "0.4.0"
  208. opam-package-upgrade
  209. opam-test
  210. opine
  211. orb
  212. ordma >= "0.0.5"
  213. ortac-core
  214. ortac-dune
  215. ortac-qcheck-stm
  216. ortac-wrapper
  217. osx-fsevents
  218. owee >= "0.8"
  219. owi >= "0.2"
  220. passage < "0.1.8"
  221. pds >= "5.42"
  222. pg_query >= "0.9.8"
  223. pkcs11-cli
  224. plotkicadsch < "0.9.0"
  225. polly >= "0.4.1"
  226. pplumbing < "0.0.16"
  227. ppx_deriving_cmdliner < "0.6.0"
  228. ppx_subliner
  229. ppxlib-tools
  230. prelude < "0.5"
  231. prof_spacetime
  232. prometheus-app
  233. protocol-9p < "0.12.1"
  234. protocol-9p-tool < "0.12.0" | >= "2.1.0"
  235. protocol-9p-unix < "0.12.1"
  236. pyast >= "0.2.0"
  237. pyml_bindgen >= "0.4.1"
  238. pyre-ast >= "0.1.9"
  239. qcow < "0.10.2" | = "0.11.0"
  240. qcow-tool < "0.11.0"
  241. qmp >= "0.20.0"
  242. queenshead
  243. quill
  244. randii
  245. reason >= "3.17.0"
  246. rosetta < "0.2.0"
  247. rpclib
  248. runtime_events_tools >= "0.5.3"
  249. runtime_events_tools_bare >= "0.5.3"
  250. rust-staticlib-gen
  251. salto-analyzer
  252. scfg >= "0.4"
  253. shared-block-ring
  254. sherlodoc < "3.1.0"
  255. slack
  256. slipshow
  257. smtml >= "0.7.0"
  258. solo5-elftool
  259. spin = "0.6.0"
  260. starred_ml >= "0.0.4"
  261. sun
  262. tallgeese
  263. tcpip >= "8.0.0"
  264. tensorflow
  265. testo
  266. testo-lwt
  267. tezos-context-hash-irmin
  268. tidy_email_mailgun
  269. tidy_email_sendgrid
  270. tidy_email_smtp
  271. timmy
  272. tls = "0.15.4" | >= "1.0.4"
  273. tls-lwt
  274. toc
  275. topkg-care
  276. torch < "v0.16.0"
  277. tuntap
  278. uring
  279. uring-trace
  280. vchan < "6.0.2"
  281. vchan-unix
  282. vendredi
  283. vif
  284. vpnkit
  285. wasm_of_ocaml-compiler
  286. wayland >= "1.1"
  287. webauthn
  288. webbrowser >= "0.6.2"
  289. xapi-inventory
  290. xen-evtchn
  291. xen-evtchn-unix
  292. xen-gnt
  293. yuscii = "0.2.0"

Conflicts

None