Generic editor for Splunk’s KV store written in Splunk’s React-UI framework.
The project contains a variety of packages that are published and versioned collectively. Each package lives in its own
directory in the
/packages directory. Each package is self contained, and defines its dependencies in a package.json file.
- Clone the repo.
- Install yarn (>= 1.2) if you haven’t already:
npm install --global yarn.
- Run the setup task:
yarn run setup.
- Ensure that your
SPLUNK_HOMEenvironment variable is set and call
yarn run link:appfrom the
This links this KV store app with your local Splunk installation
yarn run startfrom the root folder to run the local development server
- Go to http://localhost:8000/en-US/app/kv-editor/search and call the following SPL query to fill the KV store:
| inputlookup example_kv.csv | outputlookup example_kv
Then you can go to http://localhost:8000/en-US/app/kv-editor/dashboard and use the KV editor.
start– Run the
starttask for each project
build– Create a production bundle for all projects
test– Run unit tests for each project
lint– Run JS and CSS linters for each project
format– Run prettier to auto-format
*.cssfiles. This command will overwrite files without
yarn run setup once is required to enable all other tasks. The command might take a few minutes to finish.
Commands run from the root directory will be applied to all packages. This is handy when working on multiple packages
simultaneously. Commands can also be run from individual packages. This may be better for performance and reporting when
only working on a single package. All of the packages have similar developer scripts, but not all scripts are implemented
for every package. See the
package.json of the package in question to see which scripts are available there.
For more granular control of development scripts, consider using Lerna directly.