Example
subcommands
Nested commands with options and parameters at multiple levels.
In the terminal
$ ./subcommands
Successfully parsed! Here's what I got:
{ file: Err(NoValue), files: [], force: False, sc: Err(NoSubcommand) }
Source
app [main!] {
pf: platform "https://github.com/lukewilliamboswell/roc-platform-template-zig/releases/download/1.0.0/AnZoxzoGPtSGQ15EQh6pBeeaHJ7aizP9MQhK81dES3Uq.tar.zst",
weaver: "../package/main.roc",
}
import pf.Stdout
import weaver.Cli
import weaver.Opt
import weaver.Param
import weaver.SubCmd
SubSubcommandConfig : [
SS1({ a : U64, b : U64 }),
SS2({ a : U64, c : U64, data : Str }),
]
FirstSubcommandConfig : {
d : Try(U64, [NoValue]),
volume : Try(U64, [NoValue]),
sc : Try(SubSubcommandConfig, [NoSubcommand]),
}
SubcommandConfig : [
S1(FirstSubcommandConfig),
S2([DFlag(Try(U64, [NoValue]))]),
]
RootConfig : {
force : Bool,
sc : Try(SubcommandConfig, [NoSubcommand]),
file : Try(Str, [NoValue]),
files : List(Str),
}
main! : List(Str) => Try({}, _)
main! = |args| {
match Cli.parse_or_display_message(cli_parser, args.drop_first(1), str_to_raw_arg) {
Err(Help(message)) => {
Stdout.line!(message)?
Ok({})
}
Err(Version(message)) => {
Stdout.line!(message)?
Ok({})
}
Err(InvalidUsage(message)) => {
Stdout.line!(message)?
Err(Exit(1))
}
Ok(data) => {
Stdout.line!("Successfully parsed! Here's what I got:")?
Stdout.line!("")?
Stdout.line!(Str.inspect(data))?
Ok({})
}
}
}
cli_parser : Cli.CliParser(RootConfig)
cli_parser =
Cli.assert_valid(
Cli.finish(
{
force: Opt.flag({
short: "f",
long: "",
help: "Force the task to complete.",
}),
sc: SubCmd.optional([subcommand_parser1, subcommand_parser2]),
file: Param.maybe_str({
name: "file",
help: "The file to process.",
}),
files: Param.str_list({
name: "files",
help: "The rest of the files.",
}),
}.Cli,
{
name: "subcommands",
version: "v0.0.1",
authors: ["Some One <some.one@mail.com>"],
description: "This is a basic example of what you can build with Weaver. You get safe parsing, useful error messages, and help pages all for free!",
text_style: Color,
},
),
)
subcommand_parser1 : SubCmd.SubcommandParserConfig(SubcommandConfig)
subcommand_parser1 =
SubCmd.finish(
{
d: Opt.maybe_u64({
short: "d",
long: "",
help: "A non-overlapping subcommand flag with s2.",
}),
volume: Opt.maybe_u64({
short: "v",
long: "volume",
help: "How loud to grind the gears.",
}),
sc: SubCmd.optional([sub_subcommand_parser1, sub_subcommand_parser2]),
}.Cli,
{
name: "s1",
description: "A first subcommand.",
mapper: |data| S1(data),
},
)
str_to_raw_arg : Str -> [Utf8(Str), UnixBytes(List(U8)), WindowsU16s(List(U16))]
str_to_raw_arg = |arg| UnixBytes(Str.to_utf8(arg))
subcommand_parser2 : SubCmd.SubcommandParserConfig(SubcommandConfig)
subcommand_parser2 =
SubCmd.finish(
Cli.map(
Opt.maybe_u64({
short: "d",
long: "",
help: "This doesn't overlap with s1's -d flag.",
}),
|d_flag| DFlag(d_flag),
),
{
name: "s2",
description: "Another subcommand.",
mapper: |data| S2(data),
},
)
sub_subcommand_parser1 : SubCmd.SubcommandParserConfig(SubSubcommandConfig)
sub_subcommand_parser1 =
SubCmd.finish(
{
a: Opt.u64({
short: "a",
long: "",
help: "An example short flag for a sub-subcommand.",
default: NoDefault,
}),
b: Opt.u64({
short: "b",
long: "",
help: "Another example short flag for a sub-subcommand.",
default: NoDefault,
}),
}.Cli,
{
name: "ss1",
description: "A sub-subcommand.",
mapper: |data| SS1(data),
},
)
sub_subcommand_parser2 : SubCmd.SubcommandParserConfig(SubSubcommandConfig)
sub_subcommand_parser2 =
SubCmd.finish(
{
a: Opt.u64({
short: "a",
long: "",
help: "Set the alpha level.",
default: NoDefault,
}),
c: Opt.u64({
short: "c",
long: "create",
help: "Create a doohickey.",
default: NoDefault,
}),
data: Param.str({
name: "data",
help: "Data to manipulate.",
default: NoDefault,
}),
}.Cli,
{
name: "ss2",
description: "Another sub-subcommand.",
mapper: |data| SS2(data),
},
)