https://github.com/just-do-halee/argone
Most intuitive global cli maker. *(lazy_static + config-rs + clap)
https://github.com/just-do-halee/argone
argument arguments-parser clap cli command-line-interface config config-rs lazy-static rust
Last synced: 4 months ago
JSON representation
Most intuitive global cli maker. *(lazy_static + config-rs + clap)
- Host: GitHub
- URL: https://github.com/just-do-halee/argone
- Owner: just-do-halee
- License: apache-2.0
- Created: 2021-11-30T23:34:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-19T16:00:58.000Z (over 3 years ago)
- Last Synced: 2025-08-19T21:12:08.831Z (5 months ago)
- Topics: argument, arguments-parser, clap, cli, command-line-interface, config, config-rs, lazy-static, rust
- Language: Rust
- Homepage:
- Size: 18.6 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE_APACHE
Awesome Lists containing this project
README
## ***`argone`***
---
Most intuitive global cli maker. *(lazy_static + config-rs + clap)
[![CI][ci-badge]][ci-url]
[![Crates.io][crates-badge]][crates-url]
[![Licensed][license-badge]][license-url]
[![Twitter][twitter-badge]][twitter-url]
[ci-badge]: https://github.com/just-do-halee/argone/actions/workflows/rust.yml/badge.svg
[crates-badge]: https://img.shields.io/crates/v/argone.svg?labelColor=383636
[license-badge]: https://img.shields.io/crates/l/argone?labelColor=383636
[twitter-badge]: https://img.shields.io/twitter/follow/do_halee?style=flat&logo=twitter&color=4a4646&labelColor=333131&label=just-do-halee
[ci-url]: https://github.com/just-do-halee/argone/actions
[twitter-url]: https://twitter.com/do_halee
[crates-url]: https://crates.io/crates/argone
[license-url]: https://github.com/just-do-halee/argone
| [Examples](https://github.com/just-do-halee/argone/tree/main/examples) | [Docs](https://docs.rs/argone) | [Latest Note](https://github.com/just-do-halee/argone/blob/main/CHANGELOG.md) |
```toml
[dependencies]
argone = "0.5"
```
---
## *Phases*
1. Parsing `clap`.
2. If clap-argument is `None`
and the argument has `[Config]` mark
then extract data from `Config(file or env)`.
3. When the data is extracted and that was empty,
eventually set Default(=) value.
---
# `Example`
##### * ***basics***
```rust
use argone::{prelude::*, *};
ARGONE! {
version = "0.1"
author = "just-do-halee "
about = "this is our application"
Config {
// file's extension could be
// ini | json | json5 | yaml | toml | ron
file = "examples/Config"
// arg's env-prefix ex:) APP_...
prefix = "APP"
}
Args {
/// This is just one required argument.
/// and three slashes will be an 'about' for clap cli.
name: String
/// This argument is connected to Config(file or env).
/// Template is
/// [Config] $name: Option<$type> = Some($default_value) or
/// [Config] $name: Vec<$type> = vec![$default_values]
/// and this works in non-required argument.
[Config] age: Option = Some(12),
[Config] job: Vec
// And all arugments are working on clap_derive format.
/// Exactly same with clap_derive.
(short, long)
parents: Vec
/// But (default_value = "..") doesn't work to
/// the config arguments. instead, this would work.
(short, long, name = "WEIGHT")
[Config] weight: Option = Some(50)
/// In normal arguments, default_value will work.
(short, long, default_value = "1")
verbose: u8
}
commands = Sub
}
COMMANDS! {
Sub {
/// The subcommand
/// but subcommands do not have config arguments.
First {
version = "1.0"
author = "just-do-halee "
Args {
/// This area is also same.
test: String
}
}
Second {
about = "The second subcommand"
Args {
test: u8
}
}
}
}
fn main() {
println!("{:#?}", *ARGS);
if ARGS.name == "test" {
println!("name is test.");
}
if ARGS.age.unwrap() != 12 {
println!("age is not matching default 12.");
}
for job in &ARGS.job {
println!("job: {}", job);
}
for parents in &ARGS.parents {
println!("parent: {}", parents);
}
println!(
"weight is {}\nverbose is {}",
ARGS.weight.unwrap(),
ARGS.verbose
);
if let Some(sub) = &ARGS.commands {
match sub {
Sub::First { test } => println!("first command: {}", test),
Sub::Second { test } => println!("second command: {}", test),
}
} else {
println!("none subcommands");
}
}
```