Function parse_command_line 

pub fn parse_command_line() -> Result<Command, CliError>

Parses command line arguments from std::env::args().

This function automatically reads the command line arguments passed to the program and parses them into a Command struct. It skips the program name (first argument).

Returns

• Ok(Command) - If parsing succeeds
• Err(CliError) - If parsing fails

Examples

use cli_command::parse_command_string;

// When called with: myapp serve --port 8080 --host localhost
let cmd = parse_command_string("serve --port 8080 --host localhost").unwrap();
assert_eq!(cmd.name, "serve");
assert_eq!(cmd.get_argument("port"), Some("8080"));
assert_eq!(cmd.get_argument("host"), Some("localhost"));

Examples found in repository

examples/simple_server.rs (line 10)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let cmd = parse_command_line()?;

    match cmd.name.as_str() {
        "serve" => {
            println!("Starting HTTP server...");
            start_server(&cmd)?;
        }
        "help" | "--help" | "-h" => {
            print_help();
        }
        _ => {
            println!("Unknown command: {}", cmd.name);
            print_help();
        }
    }

    Ok(())
}

examples/file_processor.rs (line 9)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let cmd = parse_command_line()?;

    match cmd.name.as_str() {
        "compress" => {
            println!("Compressing files...");
            compress_files(&cmd)?;
        }
        "extract" => {
            println!("Extracting files...");
            extract_files(&cmd)?;
        }
        "list" => {
            println!("Listing files...");
            list_files(&cmd)?;
        }
        "help" | "--help" | "-h" => {
            print_help();
        }
        _ => {
            println!("Unknown command: {}", cmd.name);
            print_help();
        }
    }

    Ok(())
}

examples/cli_match_example.rs (line 47)

fn start_server() -> Result<(), Box<dyn std::error::Error>> {
    let (port, host, workers, ssl, verbose) = cli_args!(
        port: u16 = 8080,
        host: String = "localhost".to_string(),
        workers: usize = 4,
        ssl: bool = false,
        verbose: bool = false
    );

    let cmd = cli_command::parse_command_line()?;
    let config_file = cmd.get_argument("config-file");

    println!("🌐 Server Configuration:");
    println!("   Host: {}", host);
    println!("   Port: {}", port);
    println!("   Workers: {}", workers);
    println!("   SSL: {}", ssl);
    println!("   Verbose: {}", verbose);

    if let Some(config) = config_file {
        println!("   Config file: {}", config);
    }

    println!("✅ Server started successfully on {}:{}", host, port);

    Ok(())
}

/// Start a client using both cli_match! and cli_args! macros
fn start_client() -> Result<(), Box<dyn std::error::Error>> {
    let (timeout, retries, server_url) = cli_args!(
        timeout: u64 = 30,
        retries: u32 = 3,
        server_url: String = "http://localhost:8080".to_string()
    );

    let cmd = cli_command::parse_command_line()?;
    let username = cmd.get_argument("username");
    let password = cmd.get_argument("password");

    println!("📡 Client Configuration:");
    println!("   Server URL: {}", server_url);
    println!("   Timeout: {}s", timeout);
    println!("   Retries: {}", retries);

    if let Some(user) = username {
        println!("   Username: {}", user);
    }

    if let Some(pass) = password {
        println!("   Password: {}", "*".repeat(pass.len()));
    }

    println!("✅ Client connected to server successfully");

    Ok(())
}

examples/macro_example.rs (line 42)

fn start_server() -> Result<(), Box<dyn std::error::Error>> {
    let (port, host, workers) = cli_args!(
        port: u16 = 8080,
        host: String = "localhost".to_string(),
        workers: usize = 4
    );

    let cmd = cli_command::parse_command_line()?;
    let ssl = cmd.contains_argument("ssl");
    let verbose = cmd.contains_argument("verbose");
    let config_file = cmd.get_argument("config-file");

    println!("🌐 Server Configuration:");
    println!("   Host: {}", host);
    println!("   Port: {}", port);
    println!("   Workers: {}", workers);
    println!("   SSL: {}", ssl);
    println!("   Verbose: {}", verbose);

    if let Some(config) = config_file {
        println!("   Config file: {}", config);
    }

    println!("✅ Server started successfully on {}:{}", host, port);

    Ok(())
}

/// Start a client using the cli_args! macro for argument extraction
fn start_client() -> Result<(), Box<dyn std::error::Error>> {
    let (timeout, retries) = cli_args!(
        timeout: u64 = 30,
        retries: u32 = 3
    );

    let cmd = cli_command::parse_command_line()?;
    let server_url =
        cmd.get_argument_or_default("server-url", "http://localhost:8080".to_string())?;
    let username = cmd.get_argument("username");
    let password = cmd.get_argument("password");

    println!("📡 Client Configuration:");
    println!("   Server URL: {}", server_url);
    println!("   Timeout: {}s", timeout);
    println!("   Retries: {}", retries);

    if let Some(user) = username {
        println!("   Username: {}", user);
    }

    if let Some(pass) = password {
        println!("   Password: {}", "*".repeat(pass.len()));
    }

    println!("✅ Client connected to server successfully");

    Ok(())
}

examples/simple_macro_test.rs (line 19)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("🔧 Simple CLI Args Macro Demo");
    println!();

    let (name, age, email, port) = cli_args!(
        name: String = "Anonymous".to_string(),
        age: u32 = 25,
        email: String = "user@example.com".to_string(),
        port: u16 = 8080
    );

    let cmd = parse_command_line()?;
    let is_active = cmd.contains_argument("is-active");

    println!("📋 Parsed Arguments:");
    println!("   Name: {}", name);
    println!("   Age: {}", age);
    println!("   Email: {}", email);
    println!("   Active: {}", is_active);
    println!("   Port: {}", port);

    println!();
    println!("✨ Notice how the cli_args! macro eliminated this boilerplate:");
    println!("   let name = cmd.get_argument_or_default(\"name\", \"Anonymous\".to_string())?;");
    println!("   let age = cmd.get_argument_or_default(\"age\", 25)?;");
    println!(
        "   let email = cmd.get_argument_or_default(\"email\", \"user@example.com\".to_string())?;"
    );
    println!("   let is_active = cmd.get_argument_or_default(\"is_active\", true)?;");
    println!("   let port = cmd.get_argument_or_default(\"port\", 8080)?;");

    println!();
    println!("🚀 Try running with different arguments:");
    println!("   cargo run --example simple_macro_test -- --name Alice --age 30 --port 3000");
    println!("   cargo run --example simple_macro_test -- --name Bob --email bob@company.com --is-active false");

    Ok(())
}