cog-rust

简单的、有观点的库，用于在 Rust 中构建 Cog 命令。

入门指南

以下说明将帮助您复制项目并运行，以便在您的包中使用。

先决条件

# Cargo.toml
[dependencies]
cog = "0.1"

用法

编写您的包

// main.rs
extern crate cog;

fn main() {
  let res = cog::Bundle::new("my-bundle")
    .command("hello", &hello_world)
    .run()
    .expect("failed to run bundle");
}

// cog::Args is a Vec<String> and cog::Opts a HashMap<String,String>
fn hello_word(args: cog::Args, opts: cog::Opts) {
  match cog.get("name") {
    Some(name) =>
      cog::write(&format!("hello {}", name)),
    None =>
      cog::write("hello world"),
  }
}

将生成的可执行文件用于 Cog 的 config.yaml

commands:
  hello:
    executable: /usr/local/bin/my-bundle
    documentation: hello [--name=<name>]
    # ...

贡献

请阅读 CONTRIBUTING.md 了解我们的行为准则以及向我们的提交拉取请求的过程。 到目前为止，此文件尚不存在，欢迎对此提出建议。

版本控制

我们使用 SemVer 进行版本控制。有关可用的版本，请参阅此存储库的标签。

作者

• Paul d'Hubert - 初始工作 - pauldub

还可以查看参与此项目的贡献者列表。

许可证

本项目采用 MIT 许可证 - 详细信息请参阅LICENSE.md 文件

致谢

• operable 为 Cog 和良好的包系统提供了支持！