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

Conflicts

None