Generator-kibana-plugin NPM

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

Setup your Kibana development enviroment
Create a directory for your plugin that is right next to your Kibana directory.

The Kibana directory must be named kibana

kibana and your plugin directory must be siblings

ls ~/wherever/you/store/your/code
  kibana # <- where you store the Kibana development environment
  my-new-plugin # <- your plugin directory

Double check that your Node.js version matches Kibana's .node-version file
```
node --version
```
HINT: If you install nvm and avn then you can create your own .node-version file and avn will switch to it automatically!
Install Yeoman and the Kibana plugin generator
```
npm install -g yo generator-kibana-plugin
```
Run the generator inside your plugin directory
```
cd my-new-plugin
yo kibana-plugin
```
Get the URL for your Elasticsearch installation (most commonly http://localhost:9200)

Start Kibana in development mode with your new plugin included

npm start -- --elasticsearch.url 'http://localhost:9200'

# passing the elasticsearch.url here is to demonstrate how arguments can
# be passed to kibana with `npm start` but is not actually necessary if
# you are running elasticsearch locally

Visit http://localhost:5601

Options

Run the generator with the --help flag for up-to-date option docs.

yo kibana-plugin --help

Development Tasks

npm start
Start kibana and have it include this plugin
npm start -- --config kibana.yml
You can pass any argument that you would normally send to bin/kibana by putting them after -- when running npm start
npm run build
Build a distributable archive
npm run test:browser
Run the browser tests in a real web browser
npm run test:server
Run the server tests using mocha