mcpField
E
elastic-package-cli

elastic-package-cli

github.com/elastic開発16508 回インストール5 週間前に更新
リポジトリ

elastic-package-cli について

elastic-package-cli は Elastic インテグレーションパッケージの開発者向けスキルです。検証、ビルド、テスト、パッケージ管理のコマンドライン手順をまとめています。

主な機能

  1. 01パッケージの整形、検証、ビルド
  2. 02パイプラインとシステムテストの実行
  3. 03ローカル Elastic テストスタックの管理
  4. 04パッケージのインストールと状態確認

活用シーン

  1. 01ビルド前のパッケージファイル検証
  2. 02開発中のパイプラインテスト
  3. 03サービスを使ったエンドツーエンドテスト
  4. 04パッケージのインストールと状態確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/elastic/integration-skills --skill elastic-package-cli

インストール後、Claude Code で/elastic-package-cliを入力して読み込まれたか確認します。

同梱ファイルreferences/troubleshooting.md

詳細

elastic-package CLI

使用する場面

次のタスクでは、このスキルを使用します。

  • パッケージの構造とフォーマットの検証
  • パッケージ成果物のビルド
  • パイプラインテストまたはシステムテストの実行
  • ローカル Elastic テストスタックのライフサイクル管理
  • Kibana でのパッケージのインストールまたはステータス確認

使用しない場面

次の内容を扱う際に、このスキルを主なガイドとして使用しないでください。

  • ECS フィールドの設計判断（ECS に特化したスキルを使用してください）
  • インジェストプロセッサーの設計と解析方法（インジェストパイプラインに特化したスキルを使用してください）
  • パッケージレイアウトのアーキテクチャ（パッケージ構造に特化したスキルを使用してください）

前提条件

  • elastic-package がインストールされ、PATH から利用できること
  • コンテナーランタイムが利用できること（Docker または Podman）
  • パッケージディレクトリからコマンドを実行すること（または -C <package-dir> を指定すること）

主なワークフロー

1) 検証とビルドのループ

通常のローカル検証では、次の手順を実行します。

elastic-package format
elastic-package lint
elastic-package check
elastic-package build

注意：

  • check は lint とビルドをまとめて実行し、デフォルトでは最初のエラーで停止します。
  • ファイルを書き換えずに検証する場合は、format --fail-fast を使用してください。
2) パイプラインテストのループ（高速な反復）

より迅速にフィードバックを得るには、Elasticsearch のみのスタックを使用します。

elastic-package stack up -d --services=elasticsearch
elastic-package test pipeline
elastic-package test pipeline --generate

その後、変更を保持する前に、生成された期待値ファイルを確認してください。

3) システムテストのループ（エンドツーエンド）

サービスのプロビジョニングを含む完全なインジェスト動作が必要な場合に使用します。

elastic-package stack up -d
elastic-package service up
elastic-package test system

実行時間を短縮するには、--data-streams <name> を使用してテスト対象を絞り込んでください。

実用的なコマンド例

# format package files
elastic-package format

# lint against package spec and templates
elastic-package lint

# combined validation workflow
elastic-package check

# build package artifact
elastic-package build

# start only Elasticsearch for pipeline tests
elastic-package stack up -d --services=elasticsearch

# run pipeline tests
elastic-package test pipeline

# regenerate expected pipeline outputs
elastic-package test pipeline --generate

# run end-to-end system tests
elastic-package test system

主なフラグ一覧

  • グローバル：-C, --change-directory、-v, --verbose
  • スタック：-d, --daemon、-s, --services、--version、-p, --profile
  • パイプラインテスト：-d, --data-streams、-g, --generate、-m, --fail-on-missing
  • システムテスト：--setup、--tear-down、--no-provision、--variant

コマンド早見表

  • 検証／ビルド：format、lint、check、build
  • スタックのライフサイクル：stack up、stack status、stack down
  • テスト：test pipeline、test system、test static、test asset、test policy、test script
  • パッケージのライフサイクル：create、install、status、uninstall
  • サポート：service up、profiles、benchmark

参考資料

  • エラーの診断と修正：references/troubleshooting.md

コメント

Markdown 対応