@credenceanalytics/credmktcli

credmkt-cli

Support for market place page where in any kind of feature like report/app/noderedflow can be published. User can visit market place download the Package and install.

• credmkt-cli
  • Installation
    • Prerequisites
    • Online Mode
    • Offline Mode
  • Commands
    • credmktcli setup
    • credmktcli package:init
    • credmktcli package:add
    • credmktcli package:publish
    • credmktcli package:apply

Installation

Prerequisites

• Node.js >= v18 (Download Link) installed.

Online Mode

• Run the following command to install.

  $ npm install -g @credenceanalytics/credmktcli@latest
  

• Test installation by typing following command:

  $ credmktcli --help
  

Offline Mode

• Extract credmkt-cli.zip.
  • Place the extracted credmkt-cli folder to somewhere safe on your disk.
• Run npm link --force inside credmkt-cli/ folder.
• Test installation by typing following command:

  $ credmktcli --help
  

Commands

credmktcli setup

Run this command in the credence/ folder.

This command creates a new directory named custom-packages/ in the credence/ Folder.

Usage

$ credmktcli setup

Folder structure before running the command [dev environment]

credence/
  ├── visualizer-dashpages/
  ├── pages/
  ├── apps/
  └── microservices/

Folder structure after running the command [dev environment]

credence/
  ├── custom-packages/
  ├── visualizer-dashpages/
  ├── apps/
  ├── pages/
  └── microservices/

credmktcli package:init

Run this command in package repository must be a git repo.

This command helps in setting up a new package by creating a package.json file in the specified directory. It prompts the user to enter various details about the package such as name, version, description, author and keywords and writes these details into a newly created package.json file.

Usage

$ credmktcli package:init

Folder structure after running the command

<Package repo>/
  └── package.json

credmktcli package:add

This command is used to add a new visualizer dashboard or pagebuilder page to an existing package in a Git repository.

This command checks if the current directory is a Git repository and contains a package.json file. It then prompts the user to choose whether to add a visualizer dashboard or pagebuilder page to the package. If a visualizer dashboard already exists in the package, the user is asked whether they want to overwrite it.

Usage

$ credmktcli package:add

Folder structure before running the command

<Package repo>/
  └── package.json

Folder structure after running the command

└── <Package repo>/
    ├── visualizer-dashboard/
    │   └── <Added dashboard>/
    │       └── files
    ├── pages/
    │   └── <Added pages/
    │       └── files
    └── package.json

credmktcli package:publish

This command is used to update the version of a package, commit and push changes to the Git repository, and create a ZIP archive of the package.

Usage

$ credmktcli package:publish

Folder structure

└── <Package repo>/
    ├── visualizer-dashboard/
    │   └── <Added dashboard>/
    │       └── files
    ├── pages/
    │   └── <Added pages/
    │       └── files
    └── package.json

credmktcli package:apply

This command is used to extract and install a package from a specified ZIP file. This command handles extracting the package, optionally overwriting existing directories, and setting up the package correctly.

Usage

$ credmktcli package:apply

Folder structure before running the command [production environment]

└── credence/
    ├── custom-packages/
    ├── visualizer-dashpages/
    ├── apps/
    ├── microservices/
    └── pages/

Folder structure after running the command [production environment]

credence/
  ├── custom-packages/
  │   └── <Installed Package>/
  │       ├── visualizer-dashboard/
  │       │   └── <different dashboards>
  |       ├──pages/
  |       |  └──<different pages>
  │       └── package.json
  ├── visualizer-dashpages/
  │   └── dash/
  │       └── <different dashboards> 
  ├── pages/
  |   └──<different pages>
  ├── apps
  └── microservices