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

Conflicts

None