Module Async_command.Flag
val required : 'a Core__Core_command.Arg_type.t -> 'a t
Required flags must be passed exactly once.
val optional : 'a Core__Core_command.Arg_type.t -> 'a Core_kernel__.Import.option t
Optional flags may be passed at most once.
val optional_with_default : 'a -> 'a Core__Core_command.Arg_type.t -> 'a t
optional_with_default
flags may be passed at most once, and default to a given value.
val listed : 'a Core__Core_command.Arg_type.t -> 'a Core_kernel__.Import.list t
listed
flags may be passed zero or more times.
val one_or_more : 'a Core__Core_command.Arg_type.t -> ('a * 'a Core_kernel__.Import.list) t
one_or_more
flags must be passed one or more times.
val no_arg : Core_kernel__.Import.bool t
no_arg
flags may be passed at most once. The boolean returned is true iff the flag is passed on the command line.
val no_arg_register : key:'a Core_kernel.Univ_map.With_default.Key.t -> value:'a -> Core_kernel__.Import.bool t
no_arg_register ~key ~value
is likeno_arg
, but associatesvalue
withkey
in the autocomplete environment.
val no_arg_some : 'a -> 'a Core_kernel__.Import.option t
no_arg_some value
is likeno_arg
, but will returnSome value
if the flag is passed on the command line, and returnNone
otherwise.
val no_arg_abort : exit:(Core_kernel__.Import.unit -> Core_kernel__.Std_internal.never_returns) -> Core_kernel__.Import.unit t
no_arg_abort ~exit
is likeno_arg
, but aborts command-line parsing by callingexit
. This flag type is useful for "help"-style flags that just print something and exit.
val escape : Core_kernel__.Import.string Core_kernel__.Import.list Core_kernel__.Import.option t
escape
flags may be passed at most once. They cause the command line parser to abort and pass through all remaining command line arguments as the value of the flag.A standard choice of flag name to use with
escape
is"--"
.