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 和 build，默认快速失败。
  • 若要以只读方式验证且不重写文件，请使用 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