Module Cmdliner_eval

Evaluating commands

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

Evaluating commands

type``'a eval_ok`` = ``[


| ``` Ok  ``of 'a

| ``` Version ``

| ``` Help `` ]

typeeval_error`` = ``[


| ``` Parse ``

| ``` Term ``

| ``` Exn `` ]

val eval_value : ``?help:Stdlib.Format.formatter -> ``?err:Stdlib.Format.formatter ->``?catch:bool->``?env:``(``string->``string option``)``->``?argv:``string array``-> 'a Cmdliner_cmd.t -> ``('a eval_ok, eval_error)`` result

valeval_peek_opts : ``?version_opt:bool->``?env:``(``string->``string option``)``->``?argv:``string array``-> 'a Cmdliner_term.t -> 'a option`` * ``('a eval_ok, eval_error)`` result

val eval : ``?help:Stdlib.Format.formatter -> ``?err:Stdlib.Format.formatter ->``?catch:bool->``?env:``(``string->``string option``)``->``?argv:``string array``->``?term_err:int->``unitCmdliner_cmd.t -> Cmdliner_info.Exit.code

val eval' : ``?help:Stdlib.Format.formatter -> ``?err:Stdlib.Format.formatter ->``?catch:bool->``?env:``(``string->``string option``)``->``?argv:``string array``->``?term_err:int->``intCmdliner_cmd.t -> Cmdliner_info.Exit.code

val eval_result : ``?help:Stdlib.Format.formatter -> ``?err:Stdlib.Format.formatter ->``?catch:bool->``?env:``(``string->``string option``)``->``?argv:``string array``-> ``?term_err:Cmdliner_info.Exit.code ->``(unit, string)``result Cmdliner_cmd.t -> Cmdliner_info.Exit.code

val eval_result' : ``?help:Stdlib.Format.formatter -> ``?err:Stdlib.Format.formatter ->``?catch:bool->``?env:``(``string->``string option``)``->``?argv:``string array``-> ``?term_err:Cmdliner_info.Exit.code -> ``(Cmdliner_info.Exit.code, string)`` result Cmdliner_cmd.t -> Cmdliner_info.Exit.code

More from the DkSDK Book

1. DkSDK
1. 1. Package capnp
  1. Package cmdliner
  1. 1. ...
    1. Module Cmdliner_eval
    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