@nebula.js/cli
Command-line interface for nebula.js
Install
npm install -g @nebula.js/cli
Usage
nebula <command> [options]
Commands:
nebula create <name> Create a visualization
nebula build Build visualization
nebula serve Dev server
nebula sense Build a nebula visualization as a Qlik Sense extension
Options:
--version Show version number [boolean]
-h, --help Show help [boolean]
How to use nebula CLI in your visualization
You can use the package.json script variant of these commands, which are exposed for you withnebula create
When you want to make the nebula serve, nebula build, and nebula sense commands available in your visualization by yourself, run the following command.
npm install @nebula.js/cli @nebula.js/cli-build @nebula.js/cli-sense @nebula.js/cli-serve
or
yarn add @nebula.js/cli @nebula.js/cli-build @nebula.js/cli-sense @nebula.js/cli-serve
Open up package.json, those dependencies are added in your package.json file.
{
"devDependencies": {
"@nebula.js/cli": "1.7.0",
"@nebula.js/cli-build": "1.7.0",
"@nebula.js/cli-sense": "1.7.0",
"@nebula.js/cli-serve": "1.7.0"
}
}
and add a script like so:
"scripts": {
"build": "nebula build",
"start": "nebula serve",
"sense": "nebula sense"
},
How to test your modified nebula CLI locally and globally
Requirements:
- Node.js
- yarn
Clone the repository:
git clone https://github.com/qlik-oss/nebula.js
From the root directory, run the following command to install all the necessary dependencies of nebula CLI:
yarn
You can modify code in commands directory and do the following to test modified nebula CLI locally and globally:
Test nebula CLI locally
Run nebula CLI locally to see help info using node.js:
cd commands/cli
node lib/index.js -h
Test nebula CLI globally
From the commands/cli directory, run the following command to create a global symlik to the binary:
yarn link
Run nebula CLI globally to see help info to check whether it works:
nebula -h
Tips:
If 'There's already a package called "@nebula.js/cli" registered.' or 'command not found: nebula' is displayed.
Run the following command to remove the symlinked nebula and run 'yarn link' again:
yarn unlink