1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# Mìng Lìng - 命令
> [!WARNING]
>
> **Note**: Mingling is still under active development, and its API may change. Feel free to try it out and give us feedback!
`Mingling` is a Rust command-line framework. Its name comes from the Chinese Pinyin for "命令", which means "Command".
## Quick Start
The example below shows how to use `Mingling` to create a simple command-line program:
```rust
use mingling::{
hint::NoDispatcherFound,
macros::{dispatcher, program, r_println, renderer},
};
#[tokio::main]
async fn main() {
let mut program = MyProgram::new();
program.with_dispatcher(HelloCommand);
program.exec().await;
}
dispatcher!("hello", HelloCommand => HelloEntry);
#[renderer]
pub fn render_hello(_prev: HelloEntry) {
r_println!("Hello, World!")
}
#[renderer]
pub fn render_no_dispatcher_found(prev: NoDispatcherFound) {
r_println!("Subcommand not found: '{}'", prev.args.join(", "))
}
program!(MyProgram);
```
Output:
```
> mycmd hello
Hello, World!
> mycmd hallo
Subcommand not found: 'mycmd hallo'
```
## Core Concepts
Mingling abstracts command execution into the following parts:
1. **Dispatcher** - Routes user input to a specific renderer or chain based on the command node name.
2. **Chain** - Transforms the incoming type into another type, passing it to the next chain or renderer.
3. **Renderer** - Stops the chain and prints the currently processed type to the terminal.
4. **Program** - Manages the lifecycle and configuration of the entire CLI application.
## License
This project is licensed under the MIT License.
See [LICENSE-MIT](LICENSE-MIT) or [LICENSE-APACHE](LICENSE-APACHE) file for details.
|
