Function opt 

pub const fn opt(name: &'static str) -> OptSpec

Makes an OptSpec instance with a specified name.

Examples found in repository

examples/subcommands.rs (line 64)

fn try_run_sum(args: &mut noargs::RawArgs) -> noargs::Result<bool> {
    if !noargs::cmd("sum")
        .doc("Add two integers")
        .take(args)
        .is_present()
    {
        return Ok(false);
    }

    let repeat: usize = noargs::opt("repeat")
        .short('r')
        .ty("N")
        .doc("Print result multiple times")
        .default("1")
        .take(args)
        .then(|o| o.value().parse())?;
    let left: i64 = noargs::arg("<LEFT>")
        .doc("Left operand")
        .example("3")
        .take(args)
        .then(|a| a.value().parse())?;
    let right: i64 = noargs::arg("<RIGHT>")
        .doc("Right operand")
        .example("4")
        .take(args)
        .then(|a| a.value().parse())?;

    if args.metadata().help_mode {
        return Ok(true);
    }

    let total = left + right;
    for _ in 0..repeat {
        println!("{total}");
    }
    Ok(true)
}

examples/arrays.rs (line 13)

fn main() -> noargs::Result<()> {
    let mut args = noargs::raw_args();
    args.metadata_mut().app_name = env!("CARGO_PKG_NAME");
    args.metadata_mut().app_description = env!("CARGO_PKG_DESCRIPTION");

    if noargs::VERSION_FLAG.take(&mut args).is_present() {
        println!("{} {}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
        return Ok(());
    }
    noargs::HELP_FLAG.take_help(&mut args);

    // Same-name options can be collected by calling take() in a loop.
    let include_opt = noargs::opt("include")
        .short('I')
        .ty("PATH")
        .doc("Include path (can be specified multiple times)");
    let mut includes = Vec::<String>::new();
    while let Some(path) = include_opt
        .take(&mut args)
        .present_and_then(|o| o.value().parse())?
    {
        includes.push(path);
    }

    let label_opt = noargs::opt("label")
        .short('l')
        .ty("LABEL")
        .doc("Label value (can be specified multiple times)");
    let mut labels = Vec::<String>::new();
    while let Some(label) = label_opt
        .take(&mut args)
        .present_and_then(|o| o.value().parse())?
    {
        labels.push(label);
    }

    let output: String = noargs::opt("output")
        .short('o')
        .ty("PATH")
        .doc("Output path")
        .default("summary.txt")
        .take(&mut args)
        .then(|o| o.value().parse())?;

    // Positional arrays are handled with one required argument + optional rest.
    // Naming convention: use `<NAME>...` for required-many and `[NAME]...` for optional-many.
    // The `<>` / `[]` / `...` markers are cosmetic (used only in help output);
    // required-ness is enforced below: `.then()` makes the first input required,
    // the loop with `.present_and_then()` consumes zero or more rest inputs.
    let first_input: String = noargs::arg("<INPUT>")
        .doc("First input (required)")
        .example("a.txt")
        .take(&mut args)
        .then(|a| a.value().parse())?;
    let rest_input_arg = noargs::arg("[INPUT]...").doc("Additional inputs");
    let mut inputs = vec![first_input];
    while let Some(input) = rest_input_arg
        .take(&mut args)
        .present_and_then(|a| a.value().parse())?
    {
        inputs.push(input);
    }

    if let Some(help) = args.finish()? {
        print!("{help}");
        return Ok(());
    }

    println!("includes={includes:?}");
    println!("labels={labels:?}");
    println!("inputs={inputs:?}");
    println!("output={output}");
    Ok(())
}

examples/basics.rs (line 28)

fn main() -> noargs::Result<()> {
    let mut args = noargs::raw_args();
    args.metadata_mut().app_name = env!("CARGO_PKG_NAME");
    args.metadata_mut().app_description = env!("CARGO_PKG_DESCRIPTION");

    if noargs::VERSION_FLAG.take(&mut args).is_present() {
        println!("{} {}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
        return Ok(());
    }
    noargs::HELP_FLAG.take_help(&mut args);

    // Important: call flag()/opt() before arg().
    // Otherwise values like "-v" — or any unknown "--bogus" — can be silently
    // consumed as positional arguments.
    //
    // Required option / positional: set example("...") so help mode renders
    // a meaningful Usage / Example line. Optional fields covered by default()
    // or present_and_then() do not need example().
    let verbose = noargs::flag("verbose")
        .short('v')
        .doc("Enable verbose output")
        .take(&mut args)
        .is_present();
    let dry_run = noargs::flag("dry-run")
        .doc("Print parsed values and exit without running processing")
        .take(&mut args)
        .is_present();
    let retries: usize = noargs::opt("retries")
        .short('r')
        .ty("N")
        .doc("How many times to retry")
        .default("1")
        .take(&mut args)
        .then(|o| o.value().parse())?;
    let endpoint: String = noargs::opt("endpoint")
        .ty("URL")
        .doc("Server endpoint")
        .env("NOARGS_ENDPOINT")
        .default("http://localhost:8080")
        .take(&mut args)
        .then(|o| o.value().parse())?;
    let format: String = noargs::opt("format")
        .ty("FORMAT")
        .doc("Output format")
        .example("json")
        .take(&mut args)
        .then(|o| o.value().parse())?;
    let timeout_secs: Option<u64> = noargs::opt("timeout")
        .ty("SECONDS")
        .doc("Optional timeout in seconds")
        .take(&mut args)
        .present_and_then(|o| o.value().parse())?;

    let input: String = noargs::arg("<INPUT>")
        .doc("Input file path")
        .example("input.txt")
        .take(&mut args)
        .then(|a| a.value().parse())?;
    // Optional positional with default(): the value is always a String —
    // absent uses "out.txt", present uses the given path.
    // For "absent vs present" distinction, use present_and_then() and bind
    // to Option<String> — see the README's [BAZ] example.
    let output: String = noargs::arg("[OUTPUT]")
        .doc("Output file path")
        .default("out.txt")
        .take(&mut args)
        .then(|a| a.value().parse())?;

    if let Some(help) = args.finish()? {
        // When help is requested, finish() returns the built help text.
        // Print it here and exit without running application logic.
        print!("{help}");
        return Ok(());
    }

    if dry_run {
        println!(
            "dry-run: verbose={verbose}, retries={retries}, endpoint={endpoint}, format={format}, timeout_secs={timeout_secs:?}, input={input}, output={output}"
        );
        return Ok(());
    }

    println!("processing: {input} -> {output}");
    println!("using endpoint={endpoint}, format={format}, retries={retries}");
    if verbose {
        println!("verbose: timeout_secs={timeout_secs:?}");
    }

    Ok(())
}