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 (6)

Authors

  1. T
    The cmdliner programmers

Maintainers

  1. Daniel Bünzli

Sources

cmdliner-1.3.0.tbz
sha512=4c46bc334444ff772637deae2f5ba03645d7a1b7db523470a1246acfce79b971c764d964cbb02388639b3161b279700d9ade95da550446fb32aa4849c8a8f283

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 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.

Home page: http://erratique.ch/software/cmdliner

Tags

cli system declarative org:erratique

Published: 23 May 2024

README

Cmdliner — Declarative definition of command line interfaces for OCaml

v1.3.0

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 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.

Home page: 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 and API reference is automatically generated by from the source interfaces. It can be consulted online or via odig doc cmdliner.

Sample programs

If you installed Cmdliner with opam sample programs are located in the directory opam config var cmdliner:doc. These programs define the command line of some classic programs.

In the distribution sample programs are located in the test directory of the distribution. They can be built and run with:

topkg build --tests true && topkg test

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.5.0"
  6. alcotest-async
  7. alcotest-js
  8. alcotest-lwt
  9. alcotest-mirage
  10. alt-ergo >= "2.4.2" & < "2.6.3"
  11. alt-ergo-free >= "2.4.3"
  12. altgr-ergo >= "2.4.2"
  13. api-watch
  14. archsat
  15. areas-and-adversaries
  16. asak >= "0.2"
  17. atd >= "2.13.0"
  18. atdcpp
  19. atdd
  20. atdml
  21. atdpy
  22. atdts
  23. awa
  24. aws-s3
  25. b0 < "0.0.6"
  26. bancos
  27. bap-abi < "2.2.0"
  28. bap-api < "2.2.0"
  29. bap-beagle < "2.3.0"
  30. bap-bil < "2.2.0"
  31. bap-byteweight-frontend
  32. bap-cache < "2.2.0"
  33. bap-callsites
  34. bap-demangle < "2.5.0"
  35. bap-dump-symbols < "2.2.0"
  36. bap-frames
  37. bap-frontend < "2.2.0"
  38. bap-fsi-benchmark
  39. bap-ida-plugin < "2.2.0"
  40. bap-llvm < "2.2.0"
  41. bap-main
  42. bap-objdump < "2.2.0"
  43. bap-optimization < "2.2.0"
  44. bap-phoenix
  45. bap-piqi
  46. bap-plugins < "2.2.0"
  47. bap-powerpc >= "2.2.0"
  48. bap-std
  49. bap-symbol-reader < "2.2.0"
  50. bap-taint-propagator
  51. bap-term-mapper < "2.2.0"
  52. bap-trace
  53. bap-veri
  54. bap-warn-unused
  55. bap-x86
  56. benchpress
  57. benchpress-server
  58. bentov
  59. bibfmt
  60. bisect_ppx >= "2.0.0"
  61. boltzgen
  62. boulangerie
  63. brozip
  64. builder
  65. builder-web >= "0.2.0"
  66. bytepdf
  67. ca-certs-nss
  68. caisar
  69. camels < "1.0.0"
  70. camyll
  71. capnp-rpc-unix
  72. caqti >= "1.8.0"
  73. caqti-async >= "1.8.0"
  74. caqti-driver-mariadb >= "1.8.0"
  75. caqti-driver-postgresql >= "1.8.0"
  76. caqti-driver-sqlite3 >= "1.8.0"
  77. caqti-dynload = "2.0.1"
  78. caqti-eio
  79. caqti-lwt >= "1.8.0"
  80. caqti-miou
  81. carton >= "0.4.3" & < "1.0.0"
  82. carton-miou
  83. carton-miou-unix
  84. catala >= "0.7.0"
  85. catala-format >= "0.2.0"
  86. cca >= "0.6.2"
  87. certify >= "0.3.0"
  88. chamelon-unix
  89. charrua-unix
  90. checkseum >= "0.0.2" & < "0.2.0"
  91. ciao_lwt
  92. clim-ppx
  93. cmdlang-cmdliner-err-runner
  94. cmdlang-to-cmdliner
  95. cmdliner-stdlib
  96. cmdtui-lambda-term
  97. cohttp-lwt-unix != "2.5.8" & < "6.2.1"
  98. colibri2
  99. colibrics
  100. commons >= "1.8.0"
  101. compsort
  102. conex
  103. conex-mirage-crypto
  104. confero
  105. coq-lsp
  106. coq-serapi >= "8.9.0+0.6.0"
  107. cosovo
  108. cppffigen
  109. craml
  110. crockford
  111. crowbar >= "0.2.1"
  112. crunch
  113. cucumber
  114. current
  115. current-albatross-deployer
  116. current_examples
  117. current_github
  118. current_gitlab
  119. current_web
  120. decompress < "1.0.0" | >= "1.3.0"
  121. dedukti >= "2.7"
  122. depgraph
  123. diffast-git-cli < "0.3.5.1"
  124. dirsift
  125. diskuvbox
  126. dkim
  127. dkim-bin
  128. dkml-install
  129. dkml-install-installer
  130. dkml-install-runner
  131. dns-cli
  132. docfd
  133. dockerfile-cmd
  134. dockerfile-opam < "8.2.7"
  135. docteur >= "0.0.4"
  136. doi2bib
  137. dolmen_bin
  138. dream-cli
  139. dryunit
  140. dscheck >= "0.2.0"
  141. dune-deps >= "1.1.0"
  142. dune-expand
  143. dune-release >= "1.6.1" & < "2.2.0"
  144. dune_deps_extra
  145. earlybird
  146. eio-trace
  147. eio_linux >= "0.3"
  148. elasticsearch-cli
  149. electrod
  150. electrumAnalyzer
  151. elpi
  152. erlang
  153. expr
  154. extism
  155. facteur
  156. fat-filesystem
  157. fit
  158. forester >= "2.3"
  159. fsevents-lwt
  160. functoria-runtime
  161. git >= "3.2.0"
  162. git-unix >= "3.15.0"
  163. github-unix
  164. gitlab-unix >= "0.1.3"
  165. gobba
  166. gospel < "0.3.1"
  167. happy-eyeballs-lwt
  168. happy-eyeballs-miou-unix
  169. hlarp
  170. hll
  171. http-lwt-client
  172. hurl
  173. hvsock < "2.0.0" | >= "3.0.1"
  174. hxd >= "0.3.2"
  175. igvxml
  176. index >= "1.6.1"
  177. index-bench >= "1.6.1"
  178. irmin-bench
  179. irmin-cli
  180. irmin-pack != "2.10.2"
  181. irmin-pack-tools
  182. irmin-server
  183. irmin-test
  184. irmin-tezos
  185. irmin-unix
  186. jasmin >= "2023.06.0"
  187. js_of_ocaml-compiler < "6.3.0"
  188. jsonschema2atd
  189. jsonxt
  190. kafka < "0.5"
  191. kafka_lwt
  192. kaun-board
  193. ke >= "0.5"
  194. kinetic-client
  195. kmt
  196. lab
  197. labrys
  198. lambdapi != "2.1.0"
  199. learn-ocaml
  200. learn-ocaml-client
  201. ledes
  202. letsencrypt-app
  203. lilac
  204. llopt
  205. lwt_lint
  206. lwt_ppx_to_let_syntax
  207. MlFront_Cli < "2.3.1"
  208. MlFront_Logs
  209. MlFront_Tools
  210. mastodon-archive-viewer
  211. mcrunch
  212. mdx >= "2.2.0"
  213. mel
  214. melange
  215. meldep
  216. merge-fmt
  217. minicaml >= "0.2.2" & < "0.3.3"
  218. mirage >= "4.7.0" & < "4.10.2"
  219. mirage-block-ccm
  220. mirage-logs
  221. mirage-monitoring < "0.0.8"
  222. mirage-runtime >= "4.0.0"
  223. mirage-seal
  224. mkaudio
  225. mlgpx
  226. mnet-cli
  227. monorobot
  228. mrmime >= "0.5.0"
  229. mustache-cli
  230. named-pipe
  231. nbd < "4.0.3"
  232. nbd-tool
  233. niru
  234. nocoiner
  235. nuscr >= "2.0.0"
  236. obandit >= "0.3.4"
  237. obuilder
  238. ocal
  239. ocamlcodoc
  240. ocamlformat >= "0.22.4"
  241. ocamlformat-lib
  242. ocamlformat-mlx
  243. ocamlformat-mlx-lib
  244. ocamlmig
  245. ocgtk
  246. ochre-cli
  247. ocluster >= "0.2"
  248. ocp-browser >= "1.1.7"
  249. ocp-indent
  250. ocp-indent-nlfork
  251. ocp-index
  252. ocp-reloc
  253. odds
  254. odep
  255. odig < "0.1.0"
  256. odoc
  257. odoc-driver
  258. odoc-md >= "3.1.0"
  259. olint
  260. ometrics
  261. omigrate
  262. omod
  263. opam-0install >= "0.4.1"
  264. opam-0install-cudf < "0.4.1"
  265. opam-build
  266. opam-bundle
  267. opam-ci
  268. opam-client < "2.5.0~beta1"
  269. opam-compiler >= "0.2.0"
  270. opam-depext >= "1.2.1"
  271. opam-devel < "2.5.0~beta1"
  272. opam-dune-lint
  273. opam-ed
  274. opam-graph
  275. opam-grep >= "0.2.0"
  276. opam-installer < "2.5.0~beta1"
  277. opam-lib
  278. opam-lock
  279. opam-package-upgrade
  280. opam-publish >= "0.3.5" & < "3.0.0"
  281. opam-repomin
  282. opam-test
  283. opine
  284. opium
  285. orb
  286. ordma >= "0.0.5"
  287. ortac-core
  288. ortac-dune
  289. ortac-qcheck-stm
  290. ortac-wrapper
  291. orun
  292. osbx
  293. osx-fsevents
  294. oui
  295. owee >= "0.8"
  296. owi >= "0.2"
  297. owork
  298. passage < "0.3.2"
  299. passmakercmd
  300. pds >= "4.13"
  301. pg_query >= "0.9.6"
  302. pkcs11-cli
  303. plotkicadsch
  304. polly
  305. pplumbing < "0.0.16"
  306. ppx_deriving_cmdliner
  307. ppx_subliner
  308. ppxlib-tools
  309. prelude < "0.5"
  310. prof_spacetime
  311. prometheus-app
  312. protocol-9p < "0.12.1"
  313. protocol-9p-tool
  314. protocol-9p-unix < "0.12.1"
  315. pyast
  316. pyml_bindgen >= "0.4.1"
  317. pyre-ast
  318. qcow < "0.10.2" | = "0.11.0"
  319. qcow-tool
  320. qmp
  321. queenshead
  322. query-json >= "0.6.1"
  323. quill
  324. randii
  325. reason >= "3.17.0"
  326. regenerate
  327. rosetta < "0.2.0"
  328. rotor
  329. rpclib
  330. runtime_events_tools < "0.5.4"
  331. runtime_events_tools_bare < "0.5.4"
  332. rust-staticlib-gen
  333. salto-analyzer
  334. scfg >= "0.4"
  335. shakuhachi
  336. shared-block-ring
  337. sherlodoc
  338. sid
  339. slack
  340. slacko
  341. slipshow
  342. smtml
  343. solo5-elftool
  344. spin
  345. sslconf
  346. starred_ml >= "0.0.4"
  347. sun
  348. tallgeese
  349. tcpip >= "8.0.0"
  350. telltime
  351. tensorflow
  352. testo
  353. testo-lwt
  354. tidy_email_mailgun
  355. tidy_email_sendgrid
  356. tidy_email_smtp
  357. timmy
  358. tldr >= "0.3.0"
  359. tls = "0.15.4" | >= "1.0.4"
  360. tls-lwt
  361. toc
  362. topkg-care
  363. torch < "v0.16.0"
  364. touist
  365. tuntap
  366. uring
  367. uring-trace
  368. user-setup
  369. utcp
  370. valentine
  371. vchan < "6.0.2"
  372. vchan-unix
  373. vecosek
  374. vendredi
  375. vif
  376. wasm_of_ocaml-compiler < "6.3.0"
  377. wayland
  378. webauthn
  379. webbrowser >= "0.6.2"
  380. xapi-inventory
  381. xdge
  382. xen-evtchn
  383. xen-evtchn-unix
  384. xen-gnt
  385. yuscii = "0.2.0"
  386. zeit

Conflicts

None