ElasticKnown publisherelastic/integration-skills/skills/elastic-package-cli/SKILL.md

elastic-package-cli

Skill16 starsChanged 3 months agoApache-2.0View on GitHub

Use when developing or validating Elastic integrations with elastic-package commands such as build, check, lint, format, test, stack, service, install, profiles, and benchmark.

In this repository14 other files it gives its agents.
- anonymize-logsSkill
- cel-programsSkill
- create-integrationSkill
- dashboard-guidelinesSkill
- dashboard-reviewSkill
- ecs-field-mappingsSkill
- entity-mappingsSkill
- ingest-pipelinesSkill
- input-configurationsSkill
- integration-testingSkill
- maintain-integrationSkill
- package-specSkill
- research-integrationSkill
- review-integrationSkill

The file

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 5 are distinctive, and 2 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Use this skill when tasks include:
line 15
Distinctive:
Do not use this skill as the primary guide for:
line 24
Distinctive:
Run this sequence for routine local verification:
line 39
Very specific:
use format --fail-fast when you want read-only verification without rewriting files.
line 50
Distinctive:
Use Elasticsearch-only stack for quicker feedback:
line 54
Distinctive:
Use this when you need full ingest behavior with service provisioning:
line 66
Very specific:
Use --data-streams <name> to scope tests and reduce run time.
line 74

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

SKILL.md

elastic-package CLI

When to use

Use this skill when tasks include:

validating package structure and formatting
building a package artifact
running pipeline or system tests
managing local Elastic test stack lifecycle
installing or checking package status in Kibana

When not to use

Do not use this skill as the primary guide for:

ECS field design decisions (use an ECS-focused skill)
ingest processor design and parsing strategy (use an ingest-pipeline-focused skill)
package layout architecture (use a package-structure-focused skill)

Prerequisites

elastic-package is installed and available in PATH
container runtime is available (Docker or Podman)
you run commands from a package directory (or pass -C <package-dir>)

Core workflows

1) Validate and build loop

Run this sequence for routine local verification:

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

Notes:

check runs lint and build together and fails fast by default.
use format --fail-fast when you want read-only verification without rewriting files.

2) Pipeline test loop (fast iteration)

Use Elasticsearch-only stack for quicker feedback:

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

Then review generated expected files before keeping changes.

3) System test loop (end-to-end)

Use this when you need full ingest behavior with service provisioning:

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

Use --data-streams <name> to scope tests and reduce run time.

Practical command examples

# 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

Key flags cheat sheet

global: -C, --change-directory, -v, --verbose
stack: -d, --daemon, -s, --services, --version, -p, --profile
pipeline tests: -d, --data-streams, -g, --generate, -m, --fail-on-missing
system tests: --setup, --tear-down, --no-provision, --variant

Quick command map

validate/build: format, lint, check, build
stack lifecycle: stack up, stack status, stack down
testing: test pipeline, test system, test static, test asset, test policy, test script
package lifecycle: create, install, status, uninstall
support: service up, profiles, benchmark

References

Failure diagnosis and fixes: references/troubleshooting.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free