, then clone the and change directory into it:
Install dependencies
Install the version of Node.js listed in the file. This can be automated with tools such as , nvm-windows or . As we also include a .nvmrc
file you can switch to the correct version when using nvm by running:
nvm use
Install the latest version of yarn v1.
Bootstrap Kibana and install all the dependencies:
(You can also run yarn kbn
to see the other available commands. For more info about this tool, see .)
When switching branches which use different versions of npm packages you may need to run:
If you have failures during yarn kbn bootstrap
you may have some corrupted packages in your yarn cache which you can clean with:
Increase node.js heap size
Kibana is a big project and for some commands it can happen that the process hits the default heap limit and crashes with an out-of-memory error. If you run into this problem, you can increase maximum heap size by setting the --max_old_space_size
option on the command line. To set the limit for all commands, simply add the following line to your shell config: export NODE_OPTIONS="--max_old_space_size=2048"
.
Run Elasticsearch
yarn es snapshot --license trial
trial
will give you access to all capabilities.
Read about more options for Running Elasticsearch during development, like connecting to a remote host, running from source, preserving data inbetween runs, running remote cluster, etc.
In another terminal window, start up Kibana. Include developer examples by adding an optional --run-examples
flag.
View all available options by running
Code away!
You are now ready to start developing. Changes to your files should be picked up automatically. Server side changes will cause the Kibana server to reboot.