Codatum CLI

Appearance

cdm コマンド ​

概要 ​

cdm は、Codatum の機能をターミナルから操作するための CLI です。認証、データソースの参照、SQL の実行、カタログの検索・整備、仕様ドキュメントの取得に加え、ノートブックをマークダウン（*.cnb.md）でローカル編集してサーバと同期する機能も提供します。

本ドキュメントサイトの CLI リファレンスでは、マークダウン版ノートブック向けのコマンドを中心に説明します。cdm が提供するコマンドは次のとおりです。

コマンド用途
cdm updatecdm 本体を最新版に更新
cdm auth認証情報の管理
cdm skillAIエージェント向け SKILL.md の配置
cdm docドキュメントの取得
cdm notebookノートブックファイルの操作
cdm connectionコネクション情報の取得
cdm catalogカタログの検索・整備
cdm sqlSQL の実行
cdm utilID 生成・画像加工などのユーティリティ

バージョンごとの主な変更点は 変更履歴 を参照してください。

共通事項 ​

バージョンの確認 ​

--version で現在の cdm のバージョンを表示します。

sh
cdm --version

最新版が存在するかどうかは cdm update --check で確認できます。各バージョンの変更点は 変更履歴 を参照してください。

ヘルプの表示 ​

すべてのコマンド・サブコマンドで、-h / --help を指定すると、利用可能な引数・オプションの一覧を表示します。

sh
cdm --help
cdm notebook --help
cdm notebook push --help

認証 ​

内部的に API 呼び出しを伴うコマンドは、cdm auth で登録したPATを利用します。PATの権限の仕組みについては PATと権限 を参照してください。

  • profile は --profile <name> フラグで指定します。未指定時はデフォルト profile が使われます
  • CI 環境などでは CDM_PAT / CDM_PROFILE 環境変数によるオーバーライドが可能です。詳細は 環境変数によるオーバーライド を参照してください

終了コードと出力先 ​

cdm の各コマンドは、以下の方針で出力先と終了コードを使い分けます。

  • stdout: コマンドの主たるデータ出力（JSON / SQL / マークダウン等）
  • stderr: 進捗・サマリ・エラー等のメッセージ出力
  • exit 0: コマンドの正常終了（cdm sql run のSQLの実行エラー等は exit 0 で扱います）
  • exit 1: コマンドの異常終了（引数エラー、認証エラー、ネットワークエラー等）

Codatum CLI AIエージェントのための分析環境

© Codatum Inc.