Fire is a procedural macro. It will run at compile time and transform your program's source code.

Adding `fire` macro(s) as a dependency

Run this command in a terminal, in your project's directory:

cargo add fire

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

fire = "0.4.0"

You may need to import the macro(s) with use fire::*.

Read the fire documentation.

Back to the crate overview.

Readme

Rust Fire

logo

Turn your function(s) to a command line app. Inspires by Google's Python Fire.

Installation

cargo add fire

Usage

// Turn a single function to CLI app.
#[fire::fire]
fn welcome() {
    println!("Welcome!");
}

// Turn mutilple functions to CLI app.
#[fire::fire]
mod some_functions {
    pub fn hello(name: String, times: i32) {
        for _ in 0..times {
            println!("Hello, {name}!");
        }
    }

    pub fn bye() {
        println!("Bye!");
    }
}

fn main() {
    // 'Fire' the functions with command line arguments.
    fire::run!();
}

Now you can run your CLI app. By default the single function welcome should be called:

$ cargo build
$ ./target/debug/app
Welcome!

The funtions in the mod should be called as sub-command with it's function name:

$ cargo build
$ ./target/debug/app bye
Bye!

Funtions with arguments will receive the arguments from CLI app arguments, with format like --argname=argvalue:

$ cargo build
$ ./target/debug/app hello --name='John Smith' --times=3
Hello, John Smith!
Hello, John Smith!
Hello, John Smith!

Fire will call .parse() on every argument (except &str), so all types which implements FromStr plus &str is supported. For optional argument, you can use the Option generic type, like Option<String> or Option<i32>;

License

Licensed under the BSD License.

Adding fire macro(s) as a dependency

Adding `fire` macro(s) as a dependency