https://github.com/aisk/rust-fire
Turn your function(s) to a command line app with one line of code.
https://github.com/aisk/rust-fire
Last synced: about 1 year ago
JSON representation
Turn your function(s) to a command line app with one line of code.
- Host: GitHub
- URL: https://github.com/aisk/rust-fire
- Owner: aisk
- License: bsd-2-clause
- Created: 2018-02-26T05:51:12.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T08:57:41.000Z (about 2 years ago)
- Last Synced: 2025-05-01T10:55:52.493Z (about 1 year ago)
- Language: Rust
- Homepage:
- Size: 13.7 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rust Fire
Turn your function(s) to a command line app. Inspires by Google's [Python Fire](https://github.com/google/python-fire).
## Installation
```sh
cargo add fire
```
## Usage
```rust
// 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:
```sh
$ cargo build
$ ./target/debug/app
Welcome!
```
The funtions in the mod should be called as sub-command with it's function name:
```sh
$ cargo build
$ ./target/debug/app bye
Bye!
```
Funtions with arguments will receive the arguments from CLI app arguments, with format like `--argname=argvalue`:
```sh
$ 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](https://doc.rust-lang.org/std/str/trait.FromStr.html) plus `&str` is supported. For optional argument, you can use the `Option` generic type, like `Option` or `Option`;
## License
Licensed under the [BSD](https://github.com/aisk/rust-fire/blob/master/LICENSE) License.