package cmdlang-stdlib-runner

  1. Overview
  2. Docs
A basic execution runner for cmdlang based on stdlib.arg

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (2)

Authors

  1. M
    Mathieu Barbin

Maintainers

  1. M
    Mathieu Barbin <opensource@mbarbin.org>

Sources

cmdlang-0.0.10.tbz
sha256=ca68da238799022810373d060bbd528d1de7687e8f8b4a89450c0bb33a41897d
sha512=7e223e3b02da4132f3638c83cad2b0b5bd3f672d777ad09a1d956db6bbed8d93b6125d754fcc0d970b16ac8150be08f9c3ae6a066868e2128351f9e049fefe53

doc/cmdlang-stdlib-runner/Cmdlang_stdlib_runner/index.html

Module Cmdlang_stdlib_runnerSource

An execution engine for cmdlang based on stdlib.arg.

Sourceval run : 'a Cmdlang.Command.t -> 'a
Sourceval eval : 'a Cmdlang.Command.t -> argv:string array -> ('a, [ `Help of string | `Bad of string ]) Result.t
Sourceval eval_exit_code : unit Cmdlang.Command.t -> argv:string array -> int

Low level implementation

This modules should not be used directly by the users of the runner, but only through the run and eval functions. They are exposed if you want to re-use some existing code to build your own runner.

Sourcemodule Arg_runner : sig ... end

Internal representation used to run a parser.

Sourcemodule Arg_state : sig ... end

Internal representation for cmdlang arg expressions used during parsing.

Sourcemodule Command_selector : sig ... end

Selecting a command within a group hierarchy.

Sourcemodule Param_parser : sig ... end

Parsing parameters according to their specification.

Sourcemodule Parser_state : sig ... end

A mutable state that will collect parsing information.

Sourcemodule Positional_state : sig ... end

A mutable state that will collect parsing information for positional arguments.