Codatum CLI

Appearance

cdm auth ​

cdm auth サブコマンドで、Codatum の API を利用するための PAT(Personal Access Token)　を管理します。

cdm auth <subcommand> [options]
サブコマンド用途
auth loginPAT を登録
auth list登録済の profile 一覧を表示
auth useデフォルトの profile を切り替え
auth removeprofile を削除
auth whoami現在の profile の情報を表示

profile の概念 ​

  • PAT は profile 単位で管理し、複数の profile を登録できます
  • profile 名は、 英数字・ハイフン・アンダースコアのみ （正規表現: ^[a-zA-Z0-9_-]+$）に制限されます
  • 1つの profile が デフォルト として設定され、--profile フラグを指定しないコマンドはデフォルトの profile を利用します
  • PAT はワークスペース単位で発行されます。各 profile には、そのトークンが紐づくワークスペースの ID と名前を保存します

環境変数によるオーバーライド ​

CI 環境などで、直接 PAT を指定したい場合、以下の環境変数を利用できます。

環境変数用途
CDM_PAT利用する PAT を直接指定。CDM_PAT が設定されている場合、 --profile フラグは無視され、この値が優先されます。
CDM_PROFILE利用する profile 名を指定。--profile フラグの代わりに利用できます。CDM_PAT が設定されている場合は無視されます。

PAT の登録 ​

cdm auth login
  --profile <name>          登録する profile 名（未指定時は対話で入力）
  --set-default             既存 profile があっても、登録した profile をデフォルトに設定
  --app-host <url>          プレビュー等で開く Web アプリの URL（通常は省略）
  --api-host <url>          利用するAPIを変更する場合に指定（通常は省略）
  --docs-host <url>         利用するドキュメントの取得元を変更する場合に指定（通常は省略）

新しい PAT を登録します。

  • 対話プロンプトで PAT の入力を求めます
  • 入力された PAT は、API により有効性をチェックし、紐づくワークスペース ID と名前を取得します
  • 同名の profile が既に存在する場合、上書きするかを対話で確認します
  • credentials ファイルに登録済の profile が 0 件 の場合、登録した profile が自動的にデフォルトになります。それ以外の場合、デフォルトを切り替えるには --set-default を指定するか、登録後に cdm auth use を実行してください
  • CDM_PAT 環境変数が設定されている場合、対話プロンプトをスキップしてその値を PAT として使用します

profile 一覧の表示 ​

cdm auth list

登録済の profile 一覧を表示します。

  • デフォルトに設定されている profile の先頭に * が表示されます
  • トークン本体は表示されません

出力例:

  PROFILE     WORKSPACE              WORKSPACE_ID
* work        My Workspace           6653ebab5a1acaa5bd5422a5
  personal    Personal Workspace     7753ebab5a1acaa5bd5422a6

デフォルト profile の切り替え ​

cdm auth use <profile>

デフォルトの profile を切り替えます。

  • 指定した profile が登録されていない場合、exit 1 で終了します

profile の削除 ​

cdm auth remove <profile>
  -y, --yes   確認プロンプトをスキップ

指定した profile を削除します。

  • 削除前に対話プロンプトで確認を求めます。--yes を指定するとプロンプトをスキップします。
  • 削除対象がデフォルトの profile だった場合、削除後に残っている profile の 先頭 が新しいデフォルトになります。残りが 0 件のときはデフォルトが未設定になります。

現在の profile の確認 ​

cdm auth whoami
  --profile <name>   特定の profile を指定して検証

利用される profile の情報を表示し、PAT が現在も有効かを API で確認します。

  • --profile 未指定時は、CDM_PAT → CDM_PROFILE → デフォルト profile の順で解決します。
  • PAT が無効な場合、exit 1 で終了します。

出力例:

Profile: work (default)
Workspace: My Workspace (6653ebab5a1acaa5bd5422a5)
Status: OK