dx コマンド

目次

  1. 概要
  2. 構文
  3. サブコマンド
  4. section を追加
  5. バージョン履歴
  6. 関連コマンド

概要

dx コマンドは 診断ケースバンドル(DX case)の作成・整理・エクスポート を行います:target、client、job、probe、consumer、エラー、メモ、サマリーを 1 つのエクスポート可能なコンテキストに集約し、事後分析とチーム連携を容易にします。

createaddsummaryexport などのサブコマンドで、診断セッション中のあらゆる手がかりを単一の自己完結アーティファクトに集約でき、ターミナルやセッションをまたいで情報が散逸するのを防げます。エクスポート済みの DX case は issue や PR に再現エビデンスとして添付するのにも便利です。

構文

peeka-cli dx <subcommand> [options]

サブコマンド

サブコマンド 説明
create --target <id> --title <text> DX case を作成
list DX case を一覧表示
status --dx-case <id> case 状態を表示
add --dx-case <id> section を追加
summary --dx-case <id> summary を生成
export --dx-case <id> DX case をエクスポート
close --dx-case <id> DX case を閉じる

共通オプション:

オプション 説明
--target <id> 所有 target。create では必須、他のサブコマンドでは任意
--client <id> アクセス制御用の任意の所有クライアント
--format table/json 出力形式。デフォルトは table
--output-path <path> export の任意の出力先パス

section を追加

peeka-cli dx add \
  --dx-case dx_123 \
  --section-type note \
  --title "Investigation note" \
  --payload-json '{"text":"slow query reproduced"}'

--section-typetargetclientjobprobeconsumernoteerrorsummary を受け付けます。既存オブジェクトへリンクするには --object-ref-type--object-ref-id を使います。

peeka-cli dx create --target target_abcd1234 --title "Slow request"
peeka-cli dx list --target target_abcd1234
peeka-cli dx summary --dx-case dx_123
peeka-cli dx export --dx-case dx_123 --output-path ./slow-request.dx.json
peeka-cli dx close --dx-case dx_123

バージョン履歴

バージョン リリース日 変更
0.1.16 2026-06-07 dx コマンドグループを追加

関連コマンド

  • target - target を管理
  • job - コマンドジョブ情報を収集
  • probe - probe イベントを収集

トップに戻る

Copyright © 2026 Peeka contributors. Distributed under the Apache License 2.0.

This site uses Just the Docs, a documentation theme for Jekyll.