cosmo_cli

Types

Command

opaque </>

Command is a struct that represents a command in the CLI.

pub opaque type Command

Flag

opaque </>

Flag is a struct that represents a command line flag.

pub opaque type Flag

Values

get_flag_bool

</>

pub fn get_flag_bool(
  command: Command,
  flag_name: String,
) -> Result(Bool, String)

get_flag_bool returns the value of a boolean flag. the flag key must be the long name with double-hyphen.

get_flag_int

</>

pub fn get_flag_int(
  command: Command,
  flag_name: String,
) -> Result(Int, String)

get_flag_int returns the value of an int flag. the flag key must be the long name with double-hyphen.

get_flag_string

</>

pub fn get_flag_string(
  command: Command,
  flag_name: String,
) -> Result(String, String)

get_flag_string returns the value of a string flag. the flag key must be the long name with double-hyphen.

main

</>

pub fn main() -> Nil

new_command

</>

pub fn new_command(
  name name: String,
  run run: fn(Command) -> Result(Nil, String),
  option_fns option_fns: List(fn(Command) -> Command),
) -> Command

new_command creates a new command with the given name, run function, and options.

new_flag_bool

</>

pub fn new_flag_bool(
  long_name: String,
  option_fns: List(fn(Flag) -> Flag),
) -> Flag

new_flag_bool creates a new boolean flag with the given long name and options.

new_flag_int

</>

pub fn new_flag_int(
  long_name: String,
  option_fns: List(fn(Flag) -> Flag),
) -> Flag

new_flag_int creates a new int flag with the given long name and options.

new_flag_string

</>

pub fn new_flag_string(
  long_name: String,
  option_fns: List(fn(Flag) -> Flag),
) -> Flag

new_flag_string creates a new string flag with the given long name and options.

run

</>

pub fn run(
  command command: Command,
  args args: List(String),
) -> Result(Nil, String)

run executes the root command with the given arguments. It can be called with os argv that has the command name as the first argument.

run_with_argv

</>

pub fn run_with_argv(
  command command: Command,
) -> Result(Nil, String)

with_command_flags

</>

pub fn with_command_flags(
  flags: List(Flag),
) -> fn(Command) -> Command

with_command_sub_commands sets the sub commands for a command.

with_command_long

</>

pub fn with_command_long(long: String) -> fn(Command) -> Command

with_command_long sets the long description for a command.

with_command_short

</>

pub fn with_command_short(
  short: String,
) -> fn(Command) -> Command

with_command_short sets the short description for a command.

with_command_sub_commands

</>

pub fn with_command_sub_commands(
  sub_commands: Dict(String, Command),
) -> fn(Command) -> Command

with_command_run sets the run function for a command.

with_flag_default_bool

</>

pub fn with_flag_default_bool(default: Bool) -> fn(Flag) -> Flag

with_flag_default_bool sets the default value for a boolean flag.

with_flag_default_int

</>

pub fn with_flag_default_int(default: Int) -> fn(Flag) -> Flag

with_flag_default_int sets the default value for an int flag.

with_flag_default_string

</>

pub fn with_flag_default_string(
  default: String,
) -> fn(Flag) -> Flag

with_flag_default_string sets the default value for a string flag.

with_flag_description

</>

pub fn with_flag_description(
  description: String,
) -> fn(Flag) -> Flag

with_flag_description sets the description for a flag.

with_flag_short

</>

pub fn with_flag_short(short: String) -> fn(Flag) -> Flag

with_flag_long sets the long name for a flag.