Zafu/Cli/Args

`Zafu/Cli/Args`

private package

source code:

src/Zafu/Cli/Args.bosatsu

public dependencies: Zafu/Abstract/Applicative, Zafu/Cli/Args/Types, Zafu/Collection/HashMap, Zafu/Collection/NonEmptyChain, Zafu/Collection/NonEmptyList, Zafu/Control/Result, Zafu/Text/Parse/Types, Zafu/Text/Pretty

Index

Values: allow_attached, allow_equals, allow_separate, and_then_value, applicative_Args, arg_info, bool_value, clusterable, command, count, custom_name, default_help_config, default_parse_config, enum_value, example, failure_doc, flag, flag_value, float_value, help_doc, hidden, int_value, long, map, map2, map_value, one_or_more, option, option_optional_value, optional, or_else, parse, positional, positional_optional, primitive, product, product_left, product_right, pure, rest, short, string_value, subcommands, validate, value_from_fn, value_from_parse, with_aliases, with_default, with_default_doc, with_example, with_group, with_group_docs, with_help, with_help_flag, with_metavar, with_scope, with_version_flag, zero_or_more

Values

`allow_attached`

references: Zafu/Cli/Args/Types::Spelling

def allow_attached(spelling: Zafu/Cli/Args/Types::Spelling) -> Zafu/Cli/Args/Types::Spelling

`allow_equals`

references: Zafu/Cli/Args/Types::Spelling

def allow_equals(spelling: Zafu/Cli/Args/Types::Spelling) -> Zafu/Cli/Args/Types::Spelling

`allow_separate`

references: Zafu/Cli/Args/Types::Spelling

def allow_separate(spelling: Zafu/Cli/Args/Types::Spelling) -> Zafu/Cli/Args/Types::Spelling

`and_then_value`

references: Zafu/Cli/Args/Types::ValueParser, Zafu/Control/Result::Result, Zafu/Text/Pretty::Doc

def and_then_value[a, b](
    value_parser: Zafu/Cli/Args/Types::ValueParser[a],
    fn: a -> Zafu/Control/Result::Result[Zafu/Text/Pretty::Doc, b]
) -> Zafu/Cli/Args/Types::ValueParser[b]

`applicative_Args`

references: Zafu/Abstract/Applicative::Applicative, Zafu/Cli/Args/Types::Args

applicative_Args: Zafu/Abstract/Applicative::Applicative[Zafu/Cli/Args/Types::Args]

`arg_info`

references: Zafu/Cli/Args/Types::ArgInfo

arg_info: Zafu/Cli/Args/Types::ArgInfo

`bool_value`

references: Bool, Zafu/Cli/Args/Types::ValueParser, Zafu/Text/Pretty::Doc

def bool_value(metavar: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::ValueParser[Bool]

`clusterable`

references: Zafu/Cli/Args/Types::Spelling

def clusterable(spelling: Zafu/Cli/Args/Types::Spelling) -> Zafu/Cli/Args/Types::Spelling

`command`

references: String, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Command

def command[a](name: String, args: Zafu/Cli/Args/Types::Args[a]) -> Zafu/Cli/Args/Types::Command[a]

`count`

references: Int, Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Spelling, Zafu/Collection/NonEmptyList::NonEmptyList

def count(
    spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Zafu/Cli/Args/Types::Spelling],
    info: Zafu/Cli/Args/Types::ArgInfo
) -> Zafu/Cli/Args/Types::Args[Int]

`custom_name`

references: String, Zafu/Cli/Args/Types::Spelling

def custom_name(prefix: String, name: String) -> Zafu/Cli/Args/Types::Spelling

`default_help_config`

references: Zafu/Cli/Args/Types::HelpConfig

default_help_config: Zafu/Cli/Args/Types::HelpConfig

`default_parse_config`

references: Zafu/Cli/Args/Types::ParseConfig

default_parse_config: Zafu/Cli/Args/Types::ParseConfig

`enum_value`

references: String, Tuple2, Zafu/Cli/Args/Types::ValueParser, Zafu/Collection/NonEmptyList::NonEmptyList, Zafu/Text/Pretty::Doc

def enum_value[a
](cases: Zafu/Collection/NonEmptyList::NonEmptyList[(String, a)], metavar: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::ValueParser[a]

`example`

references: Zafu/Cli/Args/Types::Command, Zafu/Text/Pretty::Doc

def example[a
](cmd: Zafu/Cli/Args/Types::Command[a], doc: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::Command[a]

`failure_doc`

references: Zafu/Cli/Args/Types::CliError, Zafu/Cli/Args/Types::Command, Zafu/Cli/Args/Types::HelpConfig, Zafu/Collection/NonEmptyChain::NonEmptyChain, Zafu/Text/Pretty::Doc

def failure_doc[a](
    config: Zafu/Cli/Args/Types::HelpConfig,
    command: Zafu/Cli/Args/Types::Command[a],
    errors: Zafu/Collection/NonEmptyChain::NonEmptyChain[Zafu/Cli/Args/Types::CliError]
) -> Zafu/Text/Pretty::Doc

`flag`

references: Bool, Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Spelling, Zafu/Collection/NonEmptyList::NonEmptyList

def flag(
    spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Zafu/Cli/Args/Types::Spelling],
    info: Zafu/Cli/Args/Types::ArgInfo
) -> Zafu/Cli/Args/Types::Args[Bool]

`flag_value`

references: Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Spelling, Zafu/Collection/NonEmptyList::NonEmptyList

def flag_value[a](
    spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Zafu/Cli/Args/Types::Spelling],
    value: a,
    info: Zafu/Cli/Args/Types::ArgInfo
) -> Zafu/Cli/Args/Types::Args[a]

`float_value`

references: Float64, Zafu/Cli/Args/Types::ValueParser, Zafu/Text/Pretty::Doc

def float_value(metavar: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::ValueParser[Float64]

`help_doc`

references: List, String, Zafu/Cli/Args/Types::Command, Zafu/Cli/Args/Types::HelpConfig, Zafu/Text/Pretty::Doc

def help_doc[a](
    config: Zafu/Cli/Args/Types::HelpConfig,
    command: Zafu/Cli/Args/Types::Command[a],
    command_path: List[String]
) -> Zafu/Text/Pretty::Doc

`hidden`

references: Zafu/Cli/Args/Types::Args

def hidden[a](args: Zafu/Cli/Args/Types::Args[a]) -> Zafu/Cli/Args/Types::Args[a]

`int_value`

references: Int, Zafu/Cli/Args/Types::ValueParser, Zafu/Text/Pretty::Doc

def int_value(metavar: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::ValueParser[Int]

`long`

references: String, Zafu/Cli/Args/Types::Spelling

def long(name: String) -> Zafu/Cli/Args/Types::Spelling

`map`

references: Zafu/Cli/Args/Types::Args

def map[a, b](args: Zafu/Cli/Args/Types::Args[a], fn: a -> b) -> Zafu/Cli/Args/Types::Args[b]

`map2`

references: Zafu/Cli/Args/Types::Args

def map2[a,
    b,
    c
](left: Zafu/Cli/Args/Types::Args[a], right: Zafu/Cli/Args/Types::Args[b], fn: (a, b) -> c) -> Zafu/Cli/Args/Types::Args[c]

`map_value`

references: Zafu/Cli/Args/Types::ValueParser

def map_value[a,
    b
](value_parser: Zafu/Cli/Args/Types::ValueParser[a], fn: a -> b) -> Zafu/Cli/Args/Types::ValueParser[b]

`one_or_more`

references: Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Spelling, Zafu/Cli/Args/Types::ValueParser, Zafu/Collection/NonEmptyList::NonEmptyList

def one_or_more[a](
    value_parser: Zafu/Cli/Args/Types::ValueParser[a],
    spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Zafu/Cli/Args/Types::Spelling],
    info: Zafu/Cli/Args/Types::ArgInfo
) -> Zafu/Cli/Args/Types::Args[Zafu/Collection/NonEmptyList::NonEmptyList[a]]

`option`

references: Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Spelling, Zafu/Cli/Args/Types::ValueParser, Zafu/Collection/NonEmptyList::NonEmptyList

def option[a](
    value_parser: Zafu/Cli/Args/Types::ValueParser[a],
    spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Zafu/Cli/Args/Types::Spelling],
    info: Zafu/Cli/Args/Types::ArgInfo
) -> Zafu/Cli/Args/Types::Args[a]

`option_optional_value`

references: Option, Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Spelling, Zafu/Cli/Args/Types::ValueParser, Zafu/Collection/NonEmptyList::NonEmptyList

def option_optional_value[a](
    value_parser: Zafu/Cli/Args/Types::ValueParser[a],
    spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Zafu/Cli/Args/Types::Spelling],
    info: Zafu/Cli/Args/Types::ArgInfo
) -> Zafu/Cli/Args/Types::Args[Option[a]]

`optional`

references: Option, Zafu/Cli/Args/Types::Args

def optional[a](args: Zafu/Cli/Args/Types::Args[a]) -> Zafu/Cli/Args/Types::Args[Option[a]]

`or_else`

references: Zafu/Cli/Args/Types::Args

def or_else[a
](left: Zafu/Cli/Args/Types::Args[a], right: Zafu/Cli/Args/Types::Args[a]) -> Zafu/Cli/Args/Types::Args[a]

`parse`

references: List, String, Zafu/Cli/Args/Types::Command, Zafu/Cli/Args/Types::ParseConfig, Zafu/Cli/Args/Types::ParseResult

def parse[a](
    config: Zafu/Cli/Args/Types::ParseConfig,
    command: Zafu/Cli/Args/Types::Command[a],
    argv: List[String]
) -> Zafu/Cli/Args/Types::ParseResult[a]

`positional`

references: Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::ValueParser

def positional[a
](value_parser: Zafu/Cli/Args/Types::ValueParser[a], info: Zafu/Cli/Args/Types::ArgInfo) -> Zafu/Cli/Args/Types::Args[a]

`positional_optional`

references: Option, Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::ValueParser

def positional_optional[a
](value_parser: Zafu/Cli/Args/Types::ValueParser[a], info: Zafu/Cli/Args/Types::ArgInfo) -> Zafu/Cli/Args/Types::Args[Option[a]]

`primitive`

references: Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::PrimitiveSpec

def primitive[a
](spec: Zafu/Cli/Args/Types::PrimitiveSpec[a], info: Zafu/Cli/Args/Types::ArgInfo) -> Zafu/Cli/Args/Types::Args[a]

`product`

references: Tuple2, Zafu/Cli/Args/Types::Args

def product[a,
    b
](left: Zafu/Cli/Args/Types::Args[a], right: Zafu/Cli/Args/Types::Args[b]) -> Zafu/Cli/Args/Types::Args[(a, b)]

`product_left`

references: Zafu/Cli/Args/Types::Args

def product_left[a,
    b
](left: Zafu/Cli/Args/Types::Args[a], right: Zafu/Cli/Args/Types::Args[b]) -> Zafu/Cli/Args/Types::Args[a]

`product_right`

references: Zafu/Cli/Args/Types::Args

def product_right[a,
    b
](left: Zafu/Cli/Args/Types::Args[a], right: Zafu/Cli/Args/Types::Args[b]) -> Zafu/Cli/Args/Types::Args[b]

`pure`

references: Zafu/Cli/Args/Types::Args

def pure[a](value: a) -> Zafu/Cli/Args/Types::Args[a]

`rest`

references: List, Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::ValueParser

def rest[a
](value_parser: Zafu/Cli/Args/Types::ValueParser[a], info: Zafu/Cli/Args/Types::ArgInfo) -> Zafu/Cli/Args/Types::Args[List[a]]

`short`

references: Char, Zafu/Cli/Args/Types::Spelling

def short(ch: Char) -> Zafu/Cli/Args/Types::Spelling

`string_value`

references: String, Zafu/Cli/Args/Types::ValueParser, Zafu/Text/Pretty::Doc

def string_value(metavar: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::ValueParser[String]

`subcommands`

references: Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Command, Zafu/Collection/NonEmptyList::NonEmptyList

def subcommands[a](
    commands: Zafu/Collection/NonEmptyList::NonEmptyList[Zafu/Cli/Args/Types::Command[a]],
    info: Zafu/Cli/Args/Types::ArgInfo
) -> Zafu/Cli/Args/Types::Args[a]

`validate`

references: Zafu/Cli/Args/Types::Args, Zafu/Control/Result::Result, Zafu/Text/Pretty::Doc

def validate[a,
    b
](args: Zafu/Cli/Args/Types::Args[a], fn: a -> Zafu/Control/Result::Result[Zafu/Text/Pretty::Doc, b]) -> Zafu/Cli/Args/Types::Args[b]

`value_from_fn`

references: String, Zafu/Cli/Args/Types::ValueParser, Zafu/Control/Result::Result, Zafu/Text/Pretty::Doc

def value_from_fn[a](
    parse_fn: String -> Zafu/Control/Result::Result[Zafu/Text/Pretty::Doc, a],
    metavar: Zafu/Text/Pretty::Doc
) -> Zafu/Cli/Args/Types::ValueParser[a]

`value_from_parse`

references: Zafu/Cli/Args/Types::ValueParser, Zafu/Text/Parse/Types::Parser, Zafu/Text/Pretty::Doc

def value_from_parse[a
](parser: Zafu/Text/Parse/Types::Parser[a], metavar: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::ValueParser[a]

`with_aliases`

references: List, String, Zafu/Cli/Args/Types::Command

def with_aliases[a
](cmd: Zafu/Cli/Args/Types::Command[a], aliases: List[String]) -> Zafu/Cli/Args/Types::Command[a]

`with_default`

references: Zafu/Cli/Args/Types::Args, Zafu/Text/Pretty::Doc

def with_default[a
](args: Zafu/Cli/Args/Types::Args[a], value: a, rendered_default: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::Args[a]

`with_default_doc`

references: Zafu/Cli/Args/Types::Args, Zafu/Text/Pretty::Doc

def with_default_doc[a
](args: Zafu/Cli/Args/Types::Args[a], doc: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::Args[a]

`with_example`

references: Zafu/Cli/Args/Types::Args, Zafu/Text/Pretty::Doc

def with_example[a
](args: Zafu/Cli/Args/Types::Args[a], doc: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::Args[a]

`with_group`

references: String, Zafu/Cli/Args/Types::Args

def with_group[a
](args: Zafu/Cli/Args/Types::Args[a], group_id: String) -> Zafu/Cli/Args/Types::Args[a]

`with_group_docs`

references: String, Zafu/Cli/Args/Types::Args, Zafu/Collection/HashMap::HashMap, Zafu/Text/Pretty::Doc

def with_group_docs[a](
    args: Zafu/Cli/Args/Types::Args[a],
    group_docs: Zafu/Collection/HashMap::HashMap[String, Zafu/Text/Pretty::Doc]
) -> Zafu/Cli/Args/Types::Args[a]

`with_help`

references: Zafu/Cli/Args/Types::Args, Zafu/Text/Pretty::Doc

def with_help[a
](args: Zafu/Cli/Args/Types::Args[a], doc: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::Args[a]

`with_help_flag`

references: Zafu/Cli/Args/Types::Command

def with_help_flag[a](cmd: Zafu/Cli/Args/Types::Command[a]) -> Zafu/Cli/Args/Types::Command[a]

`with_metavar`

references: Zafu/Cli/Args/Types::Args, Zafu/Text/Pretty::Doc

def with_metavar[a
](args: Zafu/Cli/Args/Types::Args[a], doc: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::Args[a]

`with_scope`

references: Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Scope

def with_scope[a
](args: Zafu/Cli/Args/Types::Args[a], scope: Zafu/Cli/Args/Types::Scope) -> Zafu/Cli/Args/Types::Args[a]

`with_version_flag`

references: Zafu/Cli/Args/Types::Command, Zafu/Text/Pretty::Doc

def with_version_flag[a
](cmd: Zafu/Cli/Args/Types::Command[a], version_doc: Zafu/Text/Pretty::Doc) -> Zafu/Cli/Args/Types::Command[a]

`zero_or_more`

references: List, Zafu/Cli/Args/Types::ArgInfo, Zafu/Cli/Args/Types::Args, Zafu/Cli/Args/Types::Spelling, Zafu/Cli/Args/Types::ValueParser, Zafu/Collection/NonEmptyList::NonEmptyList

def zero_or_more[a](
    value_parser: Zafu/Cli/Args/Types::ValueParser[a],
    spellings: Zafu/Collection/NonEmptyList::NonEmptyList[Zafu/Cli/Args/Types::Spelling],
    info: Zafu/Cli/Args/Types::ArgInfo
) -> Zafu/Cli/Args/Types::Args[List[a]]