# kibana-plugin-helpers

**Repository Path**: mirrors_elastic/kibana-plugin-helpers

## Basic Information

- **Project Name**: kibana-plugin-helpers
- **Description**: For Kibana versions prior to 6.3: Just some helpers for writing kibana plugins
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: 7.x
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2025-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# kibana-plugin-helpers

## Note: the default branch on this repo is 7.x since the changes in master have moved to the kibana project

> **NOTE:** Kibana now includes [its own plugin helpers](https://github.com/elastic/kibana/tree/master/packages/kbn-plugin-helpers). You should use these if you are targeting Kibana 6.3+. See https://github.com/elastic/kibana/tree/master/packages/kbn-plugin-helpers for installation info.

[![Apache License](https://img.shields.io/badge/license-apache_2.0-a9215a.svg)](https://raw.githubusercontent.com/elastic/kibana-plugin-helpers/master/LICENSE)
[![CircleCI](https://img.shields.io/circleci/project/github/elastic/kibana-plugin-helpers.svg)](https://circleci.com/gh/elastic/kibana-plugin-helpers/tree/master)

Just some helpers for kibana plugin devs.

This simple CLI has several tasks that plugin devs can run from to easily debug, test, or package kibana plugins.

```sh
$ plugin-helpers help

  Usage: plugin-helpers [options] [command]

  Commands:

    start                       Start kibana and have it include this plugin
    build [options] [files...]  Build a distributable archive
    test                        Run the server and browser tests
    test:browser [options]      Run the browser tests in a real web browser
    test:server [files...]      Run the server tests using mocha

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

```

## Versions

Plugin Helpers | Kibana
-------------- | ------
[bundled plugin helpers](https://github.com/elastic/kibana/tree/master/packages/kbn-plugin-helpers) | 6.3+
7.x | 4.6.x to 6.2 (node 6+ only)
6.x | 4.6.x to 6.2
5.x | 4.x

## Configuration

`plugin-helpers` accepts a number of settings, which can be specified at runtime, or included in a `.kibana-plugin-helpers.json` file if you'd like to bundle those settings with your project.

It will also observe a `.kibana-plugin-helpers.dev.json`, much like Kibana does, which we encourage you to add to your `.gitignore` file and use for local settings that you don't intend to share. These "dev" settings will override any settings in the normal json config.

All configuration setting listed below can simply can be included in the json config files. If you intend to inline the command, you will need to convert the setting to snake case (ie. `skipArchive` becomes `--skip-archive`).

## Global settings

Setting | Description
------- | -----------
`kibanaRoot` | Path to your checkout of Kibana, relative paths are ok

### Settings for `start`

Setting | Description
------- | -----------
`includePlugins` | Intended to be used in a config file, an array of additional plugin paths to include, absolute or relative to the plugin root
`*` | Any options/flags included will be passed unmodified to the Kibana binary

### Settings for `build`

Setting | Description
------- | -----------
`skipArchive` | Don't create the zip file, leave the build path alone
`buildDestination` | Target path for the build output, absolute or relative to the plugin root
`buildVersion` | Version for the build output
`kibanaVersion` | Kibana version for the build output (added to package.json)