Skip to content

Commit

Permalink
Merge branch 'master' of github.com:elastic/kibana into telemetry/opt…
Browse files Browse the repository at this point in the history
…ional_to
  • Loading branch information
Bamieh committed Oct 25, 2020
2 parents 9be8020 + 82ba41c commit b53d2c0
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions packages/kbn-plugin-generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,22 +51,14 @@ yarn kbn bootstrap

Generated plugins receive a handful of scripts that can be used during development. Those scripts are detailed in the [README.md](template/README.md) file in each newly generated plugin, and expose the scripts provided by the [Kibana plugin helpers](../kbn-plugin-helpers), but here is a quick reference in case you need it:

> ***NOTE:*** All of these scripts should be run from the generated plugin.
> ***NOTE:*** The following scripts should be run from the generated plugin.
- `yarn kbn bootstrap`

Install dependencies and crosslink Kibana and all projects/plugins.

> ***IMPORTANT:*** Use this script instead of `yarn` to install dependencies when switching branches, and re-run it whenever your dependencies change.
- `yarn start`

Start kibana and have it include this plugin. You can pass any arguments that you would normally send to `bin/kibana`

```
yarn start --elasticsearch.hosts http://localhost:9220
```

- `yarn build`

Build a distributable archive of your plugin.
Expand All @@ -75,4 +67,15 @@ Generated plugins receive a handful of scripts that can be used during developme

Run the server tests using mocha.


To start kibana run the following command from Kibana root.

- `yarn start`

Start kibana and it will automatically include this plugin. You can pass any arguments that you would normally send to `bin/kibana`

```
yarn start --elasticsearch.hosts http://localhost:9220
```

For more information about any of these commands run `yarn ${task} --help`. For a full list of tasks run `yarn run` or take a look in the `package.json` file.

0 comments on commit b53d2c0

Please sign in to comment.