セットアップ

Epismo CLI のインストールと、JSON の入出力・終了コードの基本です。


CLI を初めてインストールするときは、このページから始めます。設定が終わったら 認証 でサインインします。

インストール

npm install -g epismo
epismo --help

CLI は Node.js 18以上を必要とします。およそ1日1回、控えめな更新チェックを行います。EPISMO_UPDATE_CHECK=0 を設定すると無効化できます(CI で便利です)。すべてのコマンドは --help に対応し、各サブコマンドも同様です(例: epismo pack create --help)。

JSON 入力

構造化データを受け取るコマンドは3通りの方法で受け取れます。インラインの JSON、@ によるファイル入力、- による標準入力です。

epismo pack create --input '{"type":"context","title":"Runbook","scope":{"type":"personal"}}'
epismo pack create --input @pack.json
cat pack.json | epismo pack create --input -

明示したフラグは --input の同名の項目を上書きします。共通のテンプレートをリポジトリに置き、実行ごとに差分だけを変えられます。

epismo track create --input @task.json --title "Override title"

出力と終了コード

CLI はスクリプト化を前提に設計されています。

  • 結果stdout に JSON で出力されます。jq などにそのままパイプできます。
  • 警告・エラーstderr に出るため、stdout の JSON を壊しません。
  • CLI は成功時に 0失敗時に0以外で終了します。if epismo …; then や CI のステップが失敗を確実に検出できます。
# エラーは別経路に出しつつ、きれいな JSON を取得する
pack=$(epismo pack get @team-onboarding) || echo "lookup failed" >&2
echo "$pack" | jq '.title'