You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updated README.md and docs/src/core-concepts/flags.md. also: main.rs is moved to examples/taskr.rs as an example file (different code too). 0.3.0 commit
Copy file name to clipboardExpand all lines: README.md
+13-5Lines changed: 13 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@
15
15
16
16
---
17
17
18
-
# Disclaimer
19
-
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.
20
-
I do not recommend using it in production.
18
+
> [!WARNING]
19
+
> 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.
20
+
> I do not recommend using it in production.
21
21
22
22
# What is vecli?
23
23
vecli is a zero-dep CLI framework made in Rust with UX in mind, and makes development of CLI tools easy and straightforward.
@@ -38,9 +38,17 @@ Then vecli is perfect for you! If not? You're at the wrong place.
38
38
- App-level strict flag mode
39
39
- Main entry point for REPL-style usage
40
40
- Interactive prompts built in: `Terminal`, `Confirm`, and `Choice`
41
+
- Nested subcommands with recursive dispatch
42
+
- Parent commands via `Command::parent()` for grouping without a handler
43
+
- Per-command `print_help_if_no_args` support
41
44
42
45
## Documentation
43
-
It's [here](https://docs.rs/vecli).
46
+
The API reference is [here](https://docs.rs/vecli).
47
+
48
+
> [!NOTE]
49
+
> The user guide is under construction. Expect the bare minimum for knowing vecli.
50
+
51
+
The user guide is [here](https://razkar-studio.github.io/vecli/).
44
52
45
53
# Usage
46
54
@@ -71,7 +79,7 @@ fn main() {
71
79
Run `cargo run hello`, and you should see `Hello!` printed to the console.
72
80
Congrats, you've created your first CLI tool using vecli! Really, it's *that* easy.
73
81
74
-
For more details and features unseen in this README, check the [documentation](https://docs.rs/vecli).
82
+
For more details and features unseen in this README, check the [documentation](https://docs.rs/vecli), or the [user guide](https://razkar-studio.github.io/vecli/).
75
83
76
84
# Installation
77
85
To install vecli as a dependency, run the following command on your cargo project:
Copy file name to clipboardExpand all lines: docs/src/core-concepts/flags.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,5 +71,3 @@ flag parsing before any command is dispatched.
71
71
---
72
72
73
73
While making commands, you may have noticed that the function takes this peculiar argument: `&CommandContext`. What is that? Know more about the [CommandContext](./context.md) as our next stop.
74
-
75
-
If you've been this far from the beginning, congrats! This doc is under production and you've reached the end... for now. More guides will be added soon! For now, read the API reference at [docs.rs](https://docs.rs/vecli).
0 commit comments