Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd/ecs - add CLI tool to check if field exists #20

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Conversation

andrewkroh
Copy link
Owner

@andrewkroh andrewkroh commented Aug 26, 2024

ecs [field]

ecs is a command-line tool for retrieving definitions of Elastic Common Schema
(ECS) fields. The field definition is written as JSON to stdout.

See https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html

OPTIONS:

  -h           Show this help message and exit.
  -r           ECS release version (e.g. 8.11.0 or 8.11 or 8).
               Defaults to latest version incorporated into
               github.com/andrewkroh/go-ecs at build time.
  -q           Quiet mode. No ECS definition is written to stdout.

ARGUMENTS:

  field        The name of the ECS field to retrieve the definition for.
               This argument is required.

EXAMPLES:

  ecs source.ip
    Retrieves the JSON definition of the "source.ip" ECS field. 

EXIT STATUS:

   0       Successful completion. Field is defined in ECS.
   1       Field not defined.
   2       Usage/argument problem.

@andrewkroh andrewkroh added the enhancement New feature or request label Aug 26, 2024
@andrewkroh andrewkroh merged commit ec67a9f into main Aug 26, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant