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

Conflicts

None