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. bancos
  22. bap-abi < "2.2.0"
  23. bap-api < "2.2.0"
  24. bap-beagle < "2.3.0"
  25. bap-bil < "2.2.0"
  26. bap-byteweight-frontend
  27. bap-cache < "2.2.0"
  28. bap-callsites
  29. bap-demangle < "2.5.0"
  30. bap-dump-symbols < "2.2.0"
  31. bap-frames
  32. bap-frontend < "2.2.0"
  33. bap-fsi-benchmark
  34. bap-ida-plugin < "2.2.0"
  35. bap-llvm < "2.2.0"
  36. bap-main < "2.2.0"
  37. bap-objdump < "2.2.0"
  38. bap-optimization < "2.2.0"
  39. bap-phoenix
  40. bap-piqi
  41. bap-plugins < "2.2.0"
  42. bap-std
  43. bap-symbol-reader < "2.2.0"
  44. bap-taint-propagator
  45. bap-term-mapper < "2.2.0"
  46. bap-trace
  47. bap-veri
  48. bap-warn-unused
  49. bap-x86 < "2.2.0"
  50. benchpress-server
  51. bibfmt
  52. boltzgen >= "0.9.5"
  53. boulangerie
  54. brozip
  55. builder
  56. builder-web >= "0.2.0"
  57. ca-certs-nss >= "3.77"
  58. caisar >= "0.2"
  59. camels >= "1.0.0"
  60. camyll >= "0.4.1"
  61. capnp-rpc-unix >= "2.1.1"
  62. caqti >= "1.8.0"
  63. caqti-async >= "1.8.0"
  64. caqti-driver-mariadb >= "1.8.0"
  65. caqti-driver-postgresql >= "1.8.0"
  66. caqti-driver-sqlite3 >= "1.8.0"
  67. caqti-dynload >= "2.0.1"
  68. caqti-eio
  69. caqti-lwt >= "1.8.0"
  70. caqti-miou
  71. carton = "0.7.2"
  72. carton-miou
  73. carton-miou-unix
  74. catala >= "0.7.0"
  75. catala-format >= "0.2.0"
  76. chamelon-unix
  77. charrua-unix >= "1.6.0"
  78. checkseum = "0.0.2" | >= "0.0.9" & < "0.2.0"
  79. clim-ppx
  80. cmdlang-cmdliner-err-runner
  81. cmdlang-to-cmdliner
  82. cmdliner-stdlib
  83. cmdtui-lambda-term
  84. cohttp-curl-lwt >= "6.2.1"
  85. cohttp-lwt-unix >= "6.0.0~beta2"
  86. commons >= "1.8.0"
  87. compsort
  88. conex >= "1.0.0"
  89. conex-mirage-crypto
  90. confero
  91. coq-lsp
  92. coq-serapi >= "8.9.0+0.6.0" & < "8.13.0+0.13.0" | >= "8.15.0+0.15.2"
  93. crockford
  94. crowbar >= "0.2.1"
  95. crunch >= "4.0.0"
  96. cucumber
  97. current
  98. current-albatross-deployer
  99. current_examples
  100. current_github
  101. current_gitlab
  102. current_web
  103. decompress >= "1.4.3"
  104. dedukti >= "2.7"
  105. diffast-git-cli >= "0.3.5.1"
  106. diskuvbox >= "0.2.0"
  107. dkim
  108. dkim-bin
  109. dkml-install-installer
  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-release >= "2.2.0"
  119. dune_deps_extra
  120. earlybird
  121. eio-trace
  122. eio_linux >= "0.3"
  123. extism
  124. facteur
  125. fat-filesystem < "0.13.0" | >= "0.15.1"
  126. fit >= "1.0.3"
  127. forester >= "5.0"
  128. functoria-runtime >= "4.0.0"
  129. git >= "3.2.0"
  130. git-unix >= "3.15.0"
  131. github-unix >= "4.5.0"
  132. gitlab-unix >= "0.1.3"
  133. happy-eyeballs-lwt >= "0.6.0"
  134. happy-eyeballs-miou-unix
  135. hlarp < "0.0.3"
  136. http-lwt-client >= "0.3.2"
  137. hvsock >= "3.0.1"
  138. hxd >= "0.3.5"
  139. index-bench >= "1.6.1"
  140. irmin-bench
  141. irmin-cli
  142. irmin-pack != "2.10.2"
  143. irmin-pack-tools
  144. irmin-server
  145. irmin-test >= "3.11.0"
  146. irmin-tezos
  147. irmin-unix
  148. jasmin >= "2023.06.0"
  149. js_of_ocaml-compiler >= "4.1.0"
  150. jsonschema2atd
  151. ke >= "0.5"
  152. kmt
  153. lab >= "0.1.4"
  154. labrys
  155. learn-ocaml
  156. learn-ocaml-client
  157. ledes
  158. letsencrypt-app
  159. MlFront_Cli < "2.3.1"
  160. MlFront_Logs
  161. MlFront_Tools
  162. markdown_monolith
  163. mastodon-archive-viewer >= "0.2"
  164. mcrunch
  165. mdx >= "2.5.1"
  166. mel
  167. melange
  168. meldep
  169. merge-fmt >= "0.3"
  170. mirage >= "4.10.2"
  171. mirage-block-ccm
  172. mirage-logs
  173. mirage-monitoring >= "0.0.8"
  174. mirage-runtime >= "4.9.0"
  175. mirage-seal
  176. mkaudio >= "1.1.4"
  177. mlgpx
  178. mnet-cli
  179. mrmime >= "0.6.0"
  180. named-pipe
  181. nbd < "4.0.3"
  182. niru
  183. nuscr >= "2.1.0"
  184. obuilder >= "0.4"
  185. ocamlformat >= "0.25.1"
  186. ocamlformat-lib >= "0.28.1"
  187. ocamlformat-mlx
  188. ocamlformat-mlx-lib >= "0.28.1.1"
  189. ocamlmig
  190. ocluster >= "0.2"
  191. ocp-browser >= "1.1.7"
  192. ocp-indent >= "1.9.0"
  193. ocp-indent-nlfork
  194. ocp-index >= "1.4.0"
  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-repomin
  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. 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. utcp
  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