vecli 0.2.0

A zero-dependency, minimal CLI framework that's genuinely readable.
Documentation 
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

<div align="center">

![vecli](images/banner.png)

**A zero-dep, minimal CLI framework that's genuinely readable.**

[![License](https://img.shields.io/badge/license-RSPL-blue)](./LICENSE.md)
[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://docs.rs/vecli)

</div>

---

# Disclaimer
vecli is currently in an unstable state, regarding its status as a new crate. The API is subject to change and the crate is experimental.
I do not recommend using it in production.

# What is vecli?
vecli is a zero-dep CLI framework made in Rust with UX in mind, and makes development of CLI tools easy and straightforward.

Do you want to make a minimal CLI app but don't want a billion dependencies or doing all by yourself?
Then vecli is perfect for you! If not? You're at the wrong place.

**Zero dependencies, minimal, but easy to use and powerful.** A great way to start learning to build CLI tools in Rust.

## Features

- Zero dependencies. Compiles instantly, minimal to zero bloat
- Subcommands as plain functions via a clean handler pattern
- Built-in `--help` and `--version` with no configuration required
- Per-command help with usage strings and flag listings
- Short flag aliases with automatic resolution to canonical names
- Global flags available across all commands
- App-level strict flag mode
- Main entry point for REPL-style usage
- Interactive prompts built in: `Terminal`, `Confirm`, and `Choice`

## Documentation
It's [here](https://docs.rs/vecli).

# Usage

![example of a cli app made in vecli](images/carbon.png)

Let's create your first CLI tool using vecli.

Create a new Rust project and add vecli as a dependency. More details [here](#installation)

Open `main.rs` and add the following code:

```rust
use vecli::*;

fn hello(_: &CommandContext) {
     println!("Hello!")
}

fn main() {
     App::new("my-app")
         .name("My App")
         .description("My App's Description")
         .add_command(Command::new("hello", hello))
         .run();
}
```

Run `cargo run hello`, and you should see `Hello!` printed to the console.
Congrats, you've created your first CLI tool using vecli! Really, it's *that* easy.

For more details and features unseen in this README, check the [documentation](https://docs.rs/vecli).

# Installation
To install vecli as a dependency, run the following command on your cargo project:

```sh
cargo add vecli
```

or alternatively, add the following to your `Cargo.toml` file:

```toml
[dependencies]
vecli = "0.2"
```

# License
This project is protected by the RazkarStudio Permissive License, a permissive source license with limitations to AI/ML training use. See [LICENSE.md](LICENSE.md) for more information.

# Contributing
Contributions are welcome! Please open an issue or submit a pull request on the [GitHub repository](https://github.com/razkar-studio/vecli).

Cheers, RazkarStudio.