@nebula.js/cli-create

@nebula.js/cli-create

Scaffold a nebula visualization or mashup.

Install

npm install -g @nebula.js/cli

Usage

CLI

nebula create <name>

Create a visualization

Commands:
  nebula create mashup <name>  Create a mashup

Positionals:
  name  name of the project                                  [string] [required]

Options:
  --version   Show version number                                      [boolean]
  --install   Run package installation step            [boolean] [default: true]
  --pkgm      Package manager          [string] [choices: "npm", "yarn", "pnpm"]
  --picasso   Picasso template [string] [choices: "none", "minimal", "barchart"]
  --author    Package author                                            [string]
  -h, --help  Show help                                                [boolean]

nebula create mashup <name>

Create a mashup

Positionals:
  name  name of the project                                  [string] [required]

Options:
      --version  Show version number                                   [boolean]
      --install  Run package installation step         [boolean] [default: true]
      --pkgm     Package manager       [string] [choices: "npm", "yarn", "pnpm"]
      --picasso  Picasso template
                               [string] [choices: "none", "minimal", "barchart"]
      --author   Package author                                         [string]
  -h, --help     Show help                                             [boolean]

Example

Create a visualization

nebula create hello-sunshine

Running nebula create without --picasso prompts a selection of the available options.

• none: without the picasso.js template
• minimal: a basic setup of picasso.js is ready
• barchart: a bar chart component created by picasso.js is ready

You can find the tutorial to build a basic nebula visualization using nebula.js.

Create a mashup

nebula create mashup hello-mashie

You can find the tutorial to build a basic mashup using nebula.js.

Package manager

Create a nebula visualization project called sn-table with the npm package manager instead of yarn

nebula create sn-table --pkgm npm

Create a mashup called table-mashup with the npm package manager instead of yarn

nebula create mashup table-mashup --pkgm npm

Package installation step

Create a nebula visualization project and do not install any dependencies yet

nebula create sn-table --install false

Create a mashup and do not install any dependencies yet

nebula create mashup table-mashup --install false

Changelog

5.5.0 (2024-09-30)

Bug Fixes

• correct type for load fallback function in embed config (#1619) (081c9c7)
• deps: update dependency webpack to v5.94.0 [security] (#1600) (db8e12a)
• use correct green color for selected (#1597) (e26f580)

Features

• dimension labels in selection bar (#1617) (73ea8f4)
• disable portal option (#1613) (3cdef85)