Appearance
cdm doc
cdm doc サブコマンドで、本ドキュメントを CLI から取得します。
cdm doc <subcommand> [options]| サブコマンド | 用途 |
|---|---|
doc index | ドキュメントの目次(llms.txt)を取得 |
doc show | 個別ドキュメントページの内容を取得 |
ドキュメントの目次取得
cdm doc indexllms.txt 形式の目次を取得します。
- 取得した内容をそのまま出力します(加工なし)。
- 目次中のパスを
doc showの<path>引数にそのまま渡せます。
個別ドキュメントページの取得
cdm doc show <path>指定したパスのドキュメントページのマークダウン本文を取得します。
<path>はdoc indexの目次に記載されたパスを 厳密に 指定してください。- 先頭の
/は必須です(例:/md/notebook.md) - 拡張子
.mdは必須です(例:/md/chart-types/XY_CHART_V2.md) - 上記を満たさない場合は、Docs ホストへのリクエスト前にバリデーションエラーで exit 1 で終了します。
- 先頭の
- 指定したパスが存在しない場合(Docs ホストが 404 を返した場合)、stderr にエラーを出力して exit 1 で終了します。