#prompt #command-line #command-line-interface #apps #help #request #build

cli_prompts_rs

轻松构建漂亮的命令行应用程序

4 个版本 (2 个重大变更)

0.3.0 2024年2月14日
0.2.0 2023年10月11日
0.1.1 2023年10月9日
0.1.0 2023年10月7日

#28#apps

MIT 许可证

195KB
1.5K SLoC

Contributors Forks Stargazers Issues MIT License LinkedIn


cli_prompt_rs

轻松构建漂亮的命令行应用程序
探索文档 »

查看演示 · 报告错误 · 请求功能

目录
  1. 关于项目
  2. 入门
  3. 用法
  4. 路线图
  5. 贡献
  6. 许可证
  7. 鸣谢

关于项目

Product Name Screen Shot

@clack/prompts 启发,这个库提供易于使用的 CLI 提示功能,帮助您轻松构建漂亮的命令行应用程序。

(返回顶部)

构建工具

  • Rust

(返回顶部)

入门

安装

在您的项目目录中运行以下 Cargo 命令

cargo add cli_prompts_rs

或者将以下行添加到您的 Cargo.toml 文件中

cli_prompts_rs = "0.2.0"

(返回顶部)

用法

以下是一个基本示例。

 use cli_prompts_rs::{CliPrompt, LogType, PromptSelectOption};
 use std::process::exit;

 fn main() {
     let mut cli_prompt = CliPrompt::new();
     cli_prompt.intro("example app").unwrap();

     cli_prompt.prompt_text("Enter your name").unwrap();

     let answer = cli_prompt.prompt_confirm("Are you sure?").unwrap();

     if !answer {
         cli_prompt.cancel("Operation cancelled").unwrap();
         exit(0);
     }

     let options = vec![
         PromptSelectOption::new("option1", "Pikachu"),
         PromptSelectOption::new("option2", "Charmander"),
         PromptSelectOption::new("option3", "Squirtle"),
     ];
     let selected_option = cli_prompt
         .prompt_select("Which one do you prefer?", options)
         .unwrap();

     cli_prompt
         .log(&format!("{}", selected_option), LogType::Info)
         .unwrap();
     cli_prompt.outro("Good Bye").unwrap();
 }

有关更多示例,请参阅文档

(返回顶部)

路线图

  • 多项选择
  • 打印备忘录
  • 颜色/样式工具

查看开放问题以获取建议功能(和已知问题的)完整列表。

(返回顶部)

贡献

贡献使开源社区成为一个学习、灵感和创造的地方。您所做的任何贡献都将被强烈赞赏。

如果您有改进此项目的建议,请克隆仓库并创建一个 pull request。您也可以简单地创建一个带有“增强”标签的问题。别忘了给项目加星!再次感谢!

  1. 克隆项目
  2. 创建您的功能分支(git checkout -b feature/AmazingFeature
  3. 提交您的更改(git commit -m '添加一些惊人的功能'
  4. 将更改推送到分支(git push origin feature/AmazingFeature
  5. 打开 pull request

此项目使用 conventional commits来自动化发布过程。

(返回顶部)

许可证

遵循MIT许可证发布。更多信息请参阅LICENSE.txt

(返回顶部)

鸣谢

(返回顶部)

依赖项

~0.5–8MB
~49K SLoC