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

Conflicts

None