# generator-kibana-plugin

**Repository Path**: jiemo/generator-kibana-plugin

## Basic Information

- **Project Name**: generator-kibana-plugin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-01-30
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 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](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md#development-environment-setup) 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](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.