Skip to content

lemo-nade-room/cli-kit

Repository files navigation

CLIKit

CLIKitは、Swiftで簡単にCLI(コマンドラインインターフェース)ツールを作成するためのライブラリです。ConsoleKitFluentなどを活用して、非同期のコマンド実行やデータベース操作をシンプルに実装できます。

Testing Status Documentation MIT License Swift 5.10+

特徴

  • 非同期のCLIコマンドを簡単に作成・管理
  • Fluentを利用したデータベース操作のサポート
  • AsyncHTTPClientを利用したHTTPリクエストサポート
  • マイグレーションや自動マイグレーション機能のサポート

サポート

  • macOS >= 14
  • 6.0 > Swift >= 5.10

インストール

CLIKitをプロジェクトに追加するには、Swift Package Managerを使用します。Package.swiftに以下の依存関係を追加してください。

dependencies: [
    .package(url: "https://github.com/lemo-nade-room/cli-kit.git", branch: "main")
]
.target(
    name: "YourApp",
    dependencies: [
        .product(name: "CLIKit", package: "cli-kit"),
    ]
),

使用例

以下のコードは、CLIKitを使って簡単なCLIを作成する例です。

let sqliteURL = FileManager()
  .homeDirectoryForCurrentUser
  .appending(path: "file.sqlite")
var cli = CLI(help: "サンプルCLI")
cli.use(AddCommand(), as: "add")
cli.use(CommitCommand(), as: "commit")
cli.migrations.add(CommitMigration())
try await cli.run()

ライセンス

このライブラリはMITライセンスで提供されています。詳細はLICENSEファイルをご覧ください。