出力フォーマット
coscli のコマンドは --json / --plain の 2 モードで出力を切り替えられます。
デフォルトは罫線なしのスペースパディング整列テキストです(人間にも AI エージェントにも読みやすい)。
--json (-J): JSON envelope 形式
すべての出力を以下の envelope で包みます。
code:json
{
"data": { /* コマンド結果 */ },
"meta": {
"command": "page.list",
"durationMs": 123,
"requestId": "uuid"
}
}
--results-only: data のみ出力
--json と組み合わせて envelope を剥がし data フィールドだけを返します。
code:bash
cos page list --project myproject --json --results-only
# → { "pages": ..., "count": 10, ... }
--select <path>: フィールド抽出
data 内の特定フィールドを jq 風のパスで抽出します。
code:text
--select 'pages' # data.pages (配列)
--select 'pages[].title' # 各ページの title を配列で返す
--select 'a.b.c' # ネストしたフィールド
使用例:
code:bash
# タイトル一覧のみ (最小トークン)
cos page list --project myproject --json --results-only --select 'pages[].title'
# → "ページA", "ページB", ...
--plain (-P): プレーン / TSV 出力
機械処理向け TSV またはシンプルなテキストを出力します。--json と排他です。
AI エージェント向けトークン節約の鉄則
Claude Code などから呼ぶ際は必要最小限のデータだけ受け取ってください。
code:bash
# タイトル一覧 (最小)
cos page list --project myproject --json --results-only --select 'pages[].title'
# ページ本文テキスト (AI 処理に最適)
cos page text "タイトル" --project myproject
# リンク先まとめて取得 (Smart Context)
cos page context "タイトル" --project myproject --hops 1 --json --results-only
環境変数
詳細は 環境変数一覧 を参照してください。
COS_JSON=1 / COS_PLAIN=1 / COS_RESULTS_ONLY=1 / COS_SELECT=<path> で設定を固定できます。
関連ページ
coscli
クイックスタート
終了コード
Smart Context
環境変数一覧
共通フラグ
#reference #agent