Skip to main content

​
概要

Jinba CLI（jinba）は、Jinbaの公式コマンドラインインターフェースです。ワークスペースの一覧取得、フローの作成・更新、ファイルのアップロードなど、Jinba Flow APIの操作をHTTPリクエストを手書きすることなくターミナルから実行できます。

​
インストール

​
動作要件

  • Node.js 20以上

​
インストール手順

CLIはnpmにパブリックパッケージとして公開されています。グローバルインストールしてください：

​
インストールの確認

​
アップデート

新しいバージョンが利用可能な場合、対話的なターミナルセッションではCLIがアップデート通知を表示します。古いバージョンはサポート対象外になることがあり、その場合はAPIから上記コマンドでのアップグレードを求められます。

​
認証

ほとんどのAPIコマンドにはJinbaのユーザーAPIキーが必要です。APIキーが未保存の状態で任意のAPIコマンドを実行すると、CLIがキーの入力を求めます：
APIキーはプロフィールページから取得できます。キーはローカルの ~/.config/jinba/config.json に保存されます。保存したキーを削除するには：
環境変数での設定も可能です（CI環境などで便利です）：

​
使い方

コマンドは次のパターンに従います：
例：
すべてのコマンドにヘルプが用意されています：

​
注意事項

  • パスパラメータは位置引数としても --workspace-id のようなフラグとしても指定できます。
  • --stdin はJSONオブジェクトを読み込み、明示的に指定したフラグとマージします。
  • 更新系コマンドは --dry-run をサポートし、Idempotency-Key を自動的に送信します。
  • 破壊的なコマンド（archive、delete、revokeなど）はデフォルトで確認プロンプトを表示します。--yes または --force でスキップできます。
  • ファイルアップロードコマンドはローカルファイルパス（例：--file ./report.pdf）を受け付け、拡張子からコンテンツタイプを推定します。