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

Conflicts

None