Module Cmdliner_term

Instructions: Use this module in your project

In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:

Add the following to your project's dependencies/CMakeLists.txt:

Copy

DkSDKProject_DeclareAvailable(cmdliner
    CONSTRAINT "= 1.1.1+dune"
    FINDLIBS cmdliner)
DkSDKProject_MakeAvailable(cmdliner)

Add the Findlib::cmdliner library to any desired targets in src/*/CMakeLists.txt:

Copy

target_link_libraries(YourPackage_YourLibraryName
     # ... existing libraries, if any ...
     Findlib::cmdliner)

Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

Run:
Copy
```
opam install cmdliner.1.1.1+dune
```

Edit your dune-project and add:

Copy

(package
  (name YourExistingPackage)
  (depends
  ; ... existing dependenices ...
  (cmdliner (>= 1.1.1+dune))))

Then run:

Copy

dune build *.opam # if this fails, run: dune build

Edit your <package>.opam file and add:

Copy

depends: [
  # ... existing dependencies ...
  "cmdliner" {>= "1.1.1+dune"}
]

Then run:

Copy

opam install . --deps-only

FINALLY, add the cmdliner library to any desired (library)and/or (executable) targets in your **/dune files:

Copy

(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    cmdliner))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    cmdliner))

typeterm_escape`` = ``[


| ``` Error  ``of bool * string

| ``` Help  `of`` `[`Cmdliner_manpage.format`](../Cmdliner_manpage/#type-format)` * string option` ]

type``'a parser`` =Cmdliner_info.Eval.t -> Cmdliner_cline.t -> ``('a, ``[ ``` Parse of string ``` | `[`term_escape`](#type-term_escape)` ])`` ``result`

Type type for command line parser. given static information about the command line and a command line to parse returns an OCaml value.

type``'a t`` =Cmdliner_info.Arg.Set.t*'a parser

The type for terms. The list of arguments it can parse and the parsing function that does so.

valconst :'a -> 'a t

val app : ``('a -> 'b)`` t -> 'a t -> 'b t

val ($) : ``('a -> 'b)`` t -> 'a t -> 'b t

type``'a ret`` = ``[


| ``` Ok  ``of 'a

| term_escape ]

valret :'a ret t -> 'a t

valterm_result : ``?usage:bool-> ``('a, ``[ ``` Msg of string ``` ]) [result](../../ocaml/Stdlib/#type-result) [t](#type-t) `-> 'a [t\](#type-t)

valterm_result' : ``?usage:bool-> ``('a, string)`` result t -> 'a t

val cli_parse_result : ``('a, ``[ ``` Msg of string ``` ]) [result](../../ocaml/Stdlib/#type-result) [t](#type-t) `-> 'a [t\](#type-t)

val cli_parse_result' : ``('a, string)`` result t -> 'a t

valmain_name : ``stringt

valchoice_names : ``string list``t

valwith_used_args :'a t -> ``('a* ``string list``)``t

More from the DkSDK Book

1. DkSDK
1. 1. Package capnp
  1. Package cmdliner
  1. 1. ...
    1. Module Cmdliner_term
    1. ...
  1. Package fmt
  1. Package logs
  1. 1. 1. Module type Logs.LOG
    1. 1. Module type Logs_lwt.LOG
  1. Package lwt
  1. Package mtime
  1. Package ocaml
  1. Package
  1. Package result
  1. Package stdint