History

Joe Fleming 079c4f0629 Fix: readme include docs (elastic/kibana-plugin-helpers#50 ) * chore: add a simple version compat chart * chore: document the settings and how to use them * chore: use icon for license info * chore: use matching badge for circleci status Original commit: elastic/kibana-plugin-helpers@1f39e488a3		2017-09-26 15:15:31 -07:00
..
bin	Bump eslint rules, update code to match rules (elastic/kibana-plugin-helpers#43 )	2017-05-02 14:37:06 -07:00
lib	Feat: add includePlugins setting (elastic/kibana-plugin-helpers#49 )	2017-09-26 14:45:54 -07:00
tasks	Feat: add includePlugins setting (elastic/kibana-plugin-helpers#49 )	2017-09-26 14:45:54 -07:00
.eslintrc	initial commit	2016-02-12 14:36:17 -07:00
.gitignore	[npm] do not commit npm logs	2016-02-14 02:28:56 -07:00
.node-version	Bump eslint rules, update code to match rules (elastic/kibana-plugin-helpers#43 )	2017-05-02 14:37:06 -07:00
circle.yml	add circle-ci config file	2016-11-17 03:29:37 -07:00
cli.js	require node 6 (elastic/kibana-plugin-helpers#42 )	2017-05-02 14:27:07 -07:00
LICENSE	added license files for better visiblity	2016-08-19 08:46:47 -07:00
package.json	v7.0.2	2017-09-20 11:04:57 -07:00
README.md	Fix: readme include docs (elastic/kibana-plugin-helpers#50 )	2017-09-26 15:15:31 -07:00
yarn.lock	chore: add yarn.lock file to repo	2017-09-20 11:04:13 -07:00

README.md

kibana-plugin-helpers

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.

$ 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
7.x	4.6+ (node 6+ only)
6.x	4.6+
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).

`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

`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)