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

Conflicts

None