combu

crates.io version license

combu is a customizable cli framework. The library name "combu" comes from command + 昆布(konbu, it means kelp in japanese).

combu has no dependencies(or depends on only std library). Crate.io's page is here.

combu(com + 昆布)は柔軟に CLI を組み上げられることを目標とした、カスタマイズ可能な CLI フレームワークです（一時クレートの名前が cmb だったこともありましたが、現在は combu です）。

Features

flag parsing in Unix format (Unix 形式でのフラグパース)
Nestable sub commmands (サブコマンド（多重可能）)
No dependencies; combu depends on only std library (標準ライブラリ以外への依存ライブラリなし)
Typed flag: Bool, String, Int and Float, inspired from seahorse（seahorse を参考にした Bool, String, Int, Float の型つきフラグ）
common flag, local flag (コモンフラグ、ローカルフラグ両方を設定可能)
flag parsing before sub command args(サブコマンド前のフラグの受付)
独自でパース等を行いたい場合に再利用できそうな構造体の設定
- 似たような CLI フレームワークを作りたいときに使用できる部品を用意
Useful presets (コマンド、フラグ等のプリセット)
Return the result of run as Result<ActionResult, ActionError> (実行結果を Result に込めて実行後返却)

Documentation

Here

Installation to your project

Combu exists on crates.io. You can use(or import) this crate like other crate that exists on crates.io.

Edit cargo.toml manually

Add

combu="[version you want to use]"

to cargo.toml.

Use cargo-edit (Recommended)

If you installed cargo-edit, exec below command under the target project:

cargo add combu

Quick Start

use combu::command::presets::func::{help, help_tablize_with_alias_dedup};
use combu::{action_result, check_help, done, preset_root, Command};
use combu::{Context, Flag};
use std::env;

fn main() {
	let _r = preset_root!(act)
		.usage(env!("CARGO_PKG_NAME").to_string() + " [args]")
		.common_flag(
			Flag::new_bool("help")
				.short_alias('h')
				.description("show help"),
		)
		.local_flag(
			Flag::new_bool("local")
				.short_alias('l')
				//.alias("test")
				.description("local flag"),
		)
		.run_from_args(env::args().collect());
}

fn act(cmd: Command, c: Context) -> action_result!() // Or use combu::{ActionResult,ActionError} and Result<ActionResult,ActionError>
{
	check_help!(cmd, c, help_tablize_with_alias_dedup);
	println!("Hello, combu - {:?}", c.args);

	done!()
	// Or use combu::Done and Ok(Done)
}

If you want to run quick start as example, exec

cargo run --example quick_start
cargo run --example quick_start --help

More detail of quick_start: See quick_start.rs

Example

Single (command has flags, but not has subcommand)

Multi (Have Sub command)

Inspired

cobra (Golang package for making cli)
seahorse (A minimal CLI framework written in Rust)
clap(Rust crate for making cli)

TODO(or Features to be implemented)

ドキュメントコメントを分かりやすくする(いつになるかは無期限未定)
必要そうなテストの実装(command.rsは済んでいる、官僚は無期限未定)
コマンド構築にあたってのプリセット実装(主だったプリセット実装は済んでいるが、追加の可能性あり)

CONTRIBUTING

If you want to contribute combu, please read CONTRIBUTING.md for checking our code of conduct, and submitting pull requests to us.

Author(s?)

suquiya.

README Contribute: ksk001100 contributed on this pull request.

License

This is licensed under MIT LICENSE

Information about construct for this README.md

combu 1.0.0