kazupon/gunshi

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

解決する課題

Gunshiは、現代的なコマンドラインインターフェース構築の複雑さを解消します。開発者は、引数の解析、サブコマンドの処理、型安全性の確保、そして人間と自動化されたAIエージェントの両方にとって使いやすいCLIを作成するという課題に直面することがよくあります。Gunshiは、最小限のボイラープレートでコマンドを定義するための構造化された方法を提供します。

仕組み

コマンドをオブジェクトとして定義し、引数(型、デフォルト値、説明を含む)とコマンドロジックを実行する run 関数を指定します。サブコマンドは subCommands オプションで追加できます。Gunshiは process.argv からの引数解析を処理し、解析された値への型安全なアクセスを提供します。ヘルプやエラーのレンダリングにはプラグイン可能なシステムを使用し、多言語出力のための国際化をサポートしており、CLIがAIエージェントによって使用されているかどうかを検知して出力を調整(例:JSON生成)することも可能です。遅延読み込みにより、サブコマンドは必要な時にのみ読み込まれます。

対象ユーザー

堅牢で保守性の高いCLIを作成したい開発者に最適です。特に、CLIをAIエージェントからアクセス可能にする予定がある場合、コマンド引数で型安全性を必要とする場合、または多数のサブコマンドを持つCLIをモジュール化したい場合に非常に有用です。国際化サポートにより、グローバルなツール開発にも適しています。

ハイライト

  • 型安全な解析を備えた、シンプルで宣言的なコマンド定義。
  • AIエージェント向けに設計:JSON出力が可能で、AIの使用を検知可能。
  • 共有コンテキストと遅延読み込みを備えた、構成可能なサブコマンド。
  • 柔軟なレンダリング:ヘルプ、使用方法、エラーメッセージのカスタマイズ。
  • 国際化およびロケール対応の設計。
  • ライフサイクルフックを備えたプラグイン可能なシステム。

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト