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.2.0"
  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-lib >= "0.28.1"
  179. ocamlformat-mlx
  180. ocamlmig
  181. ocluster >= "0.2"
  182. ocp-browser >= "1.1.7"
  183. ocp-indent >= "1.9.0"
  184. ocp-indent-nlfork
  185. ocp-index >= "1.4.0"
  186. octez-dal-node
  187. octez-internal-libs
  188. octez-libs
  189. octez-node
  190. octez-proxy-server
  191. odds >= "1.1"
  192. odep
  193. odig >= "0.1.0"
  194. odoc >= "3.1.0"
  195. odoc-driver
  196. odoc-md >= "3.1.0"
  197. omigrate >= "0.3.0"
  198. omod
  199. opam-0install-cudf < "0.4.1"
  200. opam-build
  201. opam-bundle
  202. opam-dune-lint
  203. opam-graph
  204. opam-grep >= "0.4.0"
  205. opam-package-upgrade
  206. opam-test
  207. opine
  208. orb
  209. ordma >= "0.0.5"
  210. ortac-core
  211. ortac-dune
  212. ortac-qcheck-stm
  213. ortac-wrapper
  214. osx-fsevents
  215. owee >= "0.8"
  216. owi >= "0.2"
  217. passage
  218. pds >= "5.42"
  219. pg_query >= "0.9.8"
  220. pkcs11-cli
  221. plotkicadsch < "0.9.0"
  222. polly >= "0.4.1"
  223. pplumbing < "0.0.16"
  224. ppx_deriving_cmdliner < "0.6.0"
  225. ppx_subliner
  226. ppxlib-tools
  227. prelude < "0.5"
  228. prof_spacetime
  229. prometheus-app
  230. protocol-9p < "0.12.1"
  231. protocol-9p-tool < "0.12.0" | >= "2.1.0"
  232. protocol-9p-unix < "0.12.1"
  233. pyast >= "0.2.0"
  234. pyml_bindgen >= "0.4.1"
  235. pyre-ast >= "0.1.9"
  236. qcow < "0.10.2" | = "0.11.0"
  237. qcow-tool < "0.11.0"
  238. qmp >= "0.20.0"
  239. queenshead
  240. quill
  241. randii
  242. reason >= "3.17.0"
  243. rosetta < "0.2.0"
  244. rpclib
  245. runtime_events_tools >= "0.5.3"
  246. runtime_events_tools_bare >= "0.5.3"
  247. rust-staticlib-gen
  248. salto-analyzer
  249. scfg >= "0.4"
  250. shared-block-ring
  251. sherlodoc < "3.1.0"
  252. slack
  253. slipshow
  254. smtml >= "0.7.0"
  255. solo5-elftool
  256. spin = "0.6.0"
  257. starred_ml >= "0.0.4"
  258. sun
  259. tallgeese
  260. tcpip >= "8.0.0"
  261. tensorflow
  262. testo
  263. testo-lwt
  264. tezos-context-hash-irmin
  265. tidy_email_mailgun
  266. tidy_email_sendgrid
  267. tidy_email_smtp
  268. timmy
  269. tls = "0.15.4" | >= "1.0.4"
  270. tls-lwt
  271. toc
  272. topkg-care
  273. torch < "v0.16.0"
  274. tuntap
  275. uring
  276. uring-trace
  277. vchan < "6.0.2"
  278. vchan-unix
  279. vendredi
  280. vif
  281. vpnkit
  282. wasm_of_ocaml-compiler
  283. wayland >= "1.1"
  284. webauthn
  285. webbrowser >= "0.6.2"
  286. xapi-inventory
  287. xen-evtchn
  288. xen-evtchn-unix
  289. xen-gnt
  290. yuscii = "0.2.0"

Conflicts

None