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. facteur
  127. fat-filesystem < "0.13.0" | >= "0.15.1"
  128. fit >= "1.0.3"
  129. forester >= "5.0"
  130. functoria-runtime >= "4.0.0"
  131. git >= "3.2.0"
  132. git-unix >= "3.15.0"
  133. github-unix >= "4.5.0"
  134. gitlab-unix >= "0.1.3"
  135. gospel >= "0.3.1"
  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. kaun-board
  155. ke >= "0.5"
  156. kmt
  157. lab >= "0.1.4"
  158. labrys
  159. learn-ocaml
  160. learn-ocaml-client
  161. ledes
  162. letsencrypt-app
  163. MlFront_Cli < "2.3.1"
  164. MlFront_Logs
  165. MlFront_Tools
  166. markdown_monolith
  167. mastodon-archive-viewer >= "0.2"
  168. mcrunch
  169. mdx >= "2.5.1"
  170. mel
  171. melange
  172. meldep
  173. merge-fmt >= "0.3"
  174. mirage >= "4.10.2"
  175. mirage-block-ccm
  176. mirage-logs
  177. mirage-monitoring >= "0.0.8"
  178. mirage-runtime >= "4.9.0"
  179. mirage-seal
  180. mkaudio >= "1.1.4"
  181. mlgpx
  182. mnet-cli
  183. mrmime >= "0.6.0"
  184. named-pipe
  185. nbd < "4.0.3"
  186. niru
  187. nuscr >= "2.1.0"
  188. obuilder >= "0.4"
  189. ocamlformat >= "0.25.1"
  190. ocamlformat-lib >= "0.28.1"
  191. ocamlformat-mlx
  192. ocamlformat-mlx-lib >= "0.28.1.1"
  193. ocamlmig
  194. ocluster >= "0.2"
  195. ocp-browser >= "1.1.7"
  196. ocp-indent >= "1.9.0"
  197. ocp-indent-nlfork
  198. ocp-index >= "1.4.0"
  199. odds >= "1.1"
  200. odep
  201. odig >= "0.1.0"
  202. odoc >= "3.1.0"
  203. odoc-driver
  204. odoc-md >= "3.1.0"
  205. olint
  206. omigrate >= "0.3.0"
  207. omod
  208. opam-0install-cudf < "0.4.1"
  209. opam-build
  210. opam-bundle
  211. opam-dune-lint
  212. opam-graph
  213. opam-grep >= "0.4.0"
  214. opam-package-upgrade
  215. opam-publish >= "3.0.0"
  216. opam-repomin
  217. opam-test
  218. opine
  219. oq
  220. orb
  221. ordma >= "0.0.5"
  222. ortac-core
  223. ortac-dune
  224. ortac-qcheck-stm
  225. ortac-wrapper
  226. osx-fsevents
  227. oui
  228. owee >= "0.8"
  229. owi >= "0.2"
  230. passage < "0.1.8" | >= "0.3.2"
  231. pds >= "5.42"
  232. pg_query >= "0.9.8"
  233. pkcs11-cli
  234. plotkicadsch < "0.9.0"
  235. polly >= "0.4.1"
  236. pplumbing < "0.0.16"
  237. ppx_deriving_cmdliner < "0.6.0"
  238. ppx_subliner
  239. ppxlib-tools
  240. prelude < "0.5"
  241. prof_spacetime
  242. prometheus-app
  243. protocol-9p < "0.12.1"
  244. protocol-9p-tool < "0.12.0" | >= "2.1.0"
  245. protocol-9p-unix < "0.12.1"
  246. pyast >= "0.2.0"
  247. pyml_bindgen >= "0.4.1"
  248. pyre-ast >= "0.1.9"
  249. qcow < "0.10.2" | = "0.11.0"
  250. qcow-tool < "0.11.0"
  251. qmp >= "0.20.0"
  252. queenshead
  253. query-json
  254. quickterface
  255. quill
  256. randii
  257. reason >= "3.17.0"
  258. rosetta < "0.2.0"
  259. rpclib
  260. rust-staticlib-gen
  261. salto-analyzer
  262. scfg >= "0.4"
  263. shakuhachi
  264. shared-block-ring
  265. sherlodoc < "3.1.0"
  266. slack
  267. slipshow
  268. smtml >= "0.7.0"
  269. solo5-elftool
  270. spin = "0.6.0"
  271. starred_ml >= "0.0.4"
  272. sun
  273. tallgeese
  274. tcpip >= "8.0.0"
  275. tensorflow
  276. testo
  277. testo-lwt
  278. tidy_email_mailgun
  279. tidy_email_sendgrid
  280. tidy_email_smtp
  281. timmy
  282. tls = "0.15.4" | >= "1.0.4"
  283. tls-lwt
  284. toc
  285. topkg-care
  286. torch < "v0.16.0"
  287. tuntap
  288. uring
  289. uring-trace
  290. utcp
  291. vchan < "6.0.2"
  292. vchan-unix
  293. vendredi
  294. vif
  295. wasm_of_ocaml-compiler
  296. wayland >= "1.1"
  297. webauthn
  298. webbrowser >= "0.6.2"
  299. xapi-inventory
  300. xdge
  301. xen-evtchn
  302. xen-evtchn-unix
  303. xen-gnt
  304. yuscii = "0.2.0"

Conflicts

None