kazupon/gunshi

Gunshi: JavaScript command-line library, your strategist for CLIs that people and AI agents use

它解决了什么问题

Gunshi 解决了构建现代命令行界面的复杂性。开发者在处理参数解析、子命令管理、确保类型安全以及使 CLI 同时易于人类和自动化 AI 代理使用时,往往面临诸多挑战。Gunshi 提供了一种结构化的方式来定义命令,且样板代码极少。

工作原理

你可以将命令定义为对象,指定参数(包含类型、默认值和描述)以及执行命令逻辑的 run 函数。可以通过 subCommands 选项添加子命令。Gunshi 处理来自 process.argv 的参数解析,并提供对解析值的类型安全访问。它使用可插拔系统来渲染帮助信息和错误,支持多语言输出的国际化,并能检测 CLI 是否正被 AI 代理使用以调整输出(例如生成 JSON)。延迟加载允许子命令仅在需要时才被加载。

适用人群

它适用于希望创建健壮、可维护 CLI 的开发者。如果你计划让你的 CLI 可供 AI 代理访问、需要在命令参数中实现类型安全,或者希望模块化具有多个子命令的 CLI,它将特别有用。国际化支持使其非常适合全球化工具开发。

亮点

  • 简单、声明式的命令定义,支持类型安全解析。
  • 专为 AI 代理构建:可输出 JSON 并检测 AI 使用情况。
  • 具有共享上下文和延迟加载的可组合子命令。
  • 灵活的渲染:自定义帮助、用法和错误消息。
  • 国际化和支持本地化的设计。
  • 带有生命周期钩子的可插拔插件系统。

相关

  • 项目
  • 项目
  • 项目
  • 项目