/generator-kibana-plugin

A Yeoman Generator for Kibana Plugins

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Kibana Plugin Yeoman Generator

This project is a Yeoman generator for bootstrapping a Kibana Plugin. It creates a basic hello world Kibana plugin with all the elements in place so you can easily get started with creating your first Kibana plugin.

Getting Started

First you need to install Yeoman

npm install -g yo

Then you need to install the Kibana Plugin generator

npm install -g generator-kibana-plugin

Then generate your new plugin

mkdir my-new-plugin
cd my-new-plugin
yo kibana-plugin

Assuming you've setup a Kibana development enviroment at the same level as your plugin directory (and named it kibana). Then run the following command inside your plugin directory.

npm start

With Elasticsearch already running you should now start Kibana in dev mode.

cd ../kibana
bin/kibana --dev

Visit http://localhost:5601

options

If you start the generator with the --minimal flag, it will not generate any sample code only the bare folder structure.

If you start the generator with the --advanced flag, you can choose what sample components it should generate for you.