Appearance
cdm doc
cdm doc サブコマンドで、本ドキュメントを CLI から取得します。
cdm doc <subcommand> [options]| サブコマンド | 用途 |
|---|---|
doc index | ドキュメントの目次(llms.txt)を取得 |
doc show | 個別ドキュメントページの内容を取得 |
doc full | 全ドキュメントを単一ファイル(llms-full.txt)で取得 |
ドキュメントの目次取得
cdm doc indexllms.txt 形式の目次を取得します。
doc showの<path>には、目次に記載された URL から パス部分 を抽出して渡してください- 例:
https://cli-docs.codatum.com/md/notebook.md→/md/notebook.md
- 例:
個別ドキュメントページの取得
cdm doc show <path>指定したパスのドキュメントページのマークダウン本文を取得します。
<path>はdoc indexの目次に記載された URL の パス部分 を指定してください- 先頭の
/は必須です(例:/md/notebook.md) - 拡張子
.mdは必須です(例:/md/chart-types/XY_CHART_V2.md) - 目次の URL をそのまま渡すことはできません
- 上記を満たさない場合は、Docs ホストへのリクエスト前にバリデーションエラーで exit 1 で終了します
- 先頭の
- 指定したパスが存在しない場合(Docs ホストが 404 を返した場合)、stderr にエラーを出力して exit 1 で終了します
全ドキュメントの一括取得
cdm doc full全ドキュメントを結合した llms-full.txt 形式の単一テキストを取得します。
- 全ページを丸ごと取得するため出力が大きくなります(数百KB〜)
- ファイルに保存して
grep等で検索する用途を想定しています
cdm doc full > llms-full.txt
grep -n "keyword" llms-full.txt