iwfcli

The "@credenceanalytics/iwfcli" npm package is a powerful command-line interface (CLI) tool designed to simplify the management and configuration of applications. With a wide range of commands and functionalities, this package provides developers with a convenient way to initialize, configure, and troubleshoot their applications.

The package offers a comprehensive set of commands for tasks such as initializing the application, updating database details, configuring Java settings, managing RabbitMQ configurations, changing ports, and modifying product details. It also provides features for extracting logs, creating thread and heap dump files, generating encryption key-pairs, and migrating existing configurations to newer versions.

The CLI tool is easy to install globally using npm, and it requires Node.js version 14.16.0 or higher and Oracle Instant Client version 18.5.0.0 for proper functioning.

Installation

Prerequisites

iwfcli installation need:

• Node.js >=14.16.0 (Download Link) installed.
• Oracle Instant Client == 18.5.0.0 (Download Link) installed.

Online Mode

• iwfcli is available in npm. To install it, type:

  $ npm i -g @credenceanalytics/iwfcli

  See how

Offline Mode

• Extract iwfcli.zip. Place the extracted iwfcli folder to somewhere safe on your disk.

• Run npm link --force inside iwfcli folder. (This will start the installation process)

  

• Test installation by typing following command:

  $ iwfcli --help

Commands

iwfcli config:init

Initialize the application. Takes input of paths of the JBOSS server directory and all the other microservice and creates a config.json file and stores the paths in it.

USAGE
  $ iwfcli config:init

iwfcli config:database

Initialize or update the database details. For any errors reinitialize using iwfcli config:init command. Sensitive data encryption is now supported.

USAGE
  $ iwfcli config:database

iwfcli config:java

Update the java details in the JBOSS folder. For any errors reinitialize using config:init command.

USAGE
  $ iwfcli config:java

iwfcli config:mq

Initialize the rabbitMq config files. For any errors reinitialize using config:init command. Sensitive data encryption is now supported. Feature to store MQ details into database in case of Wildfly/JBoss WAR.

USAGE
  $ iwfcli config:mq

iwfcli config:port

Change the port for nrest and App Server application.

USAGE
  $ iwfcli config:port

iwfcli config:product

Change the product details. Sensitive data encryption is now supported.

USAGE
  $ iwfcli config:product

iwfcli info:system

Display system information on console.

USAGE
  $ iwfcli info:system

iwfcli extract:logs

Extract logs from installed microservices and application (jboss/wildfly).

USAGE
  $ iwfcli extract:logs

iwfcli create:threaddump

Creates java thread dump file for application (jboss/wildfly) in current working directory.

USAGE
  $ iwfcli create:threaddump

iwfcli create:heapdump

Creates java heap dump file for application (JBoss/Wildfly) in current working directory.

USAGE
  $ iwfcli create:heapdump

iwfcli generate:keys

Create new encryption key-pairs and store them in microservice/keys/ folder.

USAGE
  $ iwfcli generate:keys

OPTIONS
  --bits=bits                    The size of the encryption key to generate in bits. It should be 1024 OR 2048. e.g --bits=1024
  --location=location            Path where encryption keys should be generated. e.g= --location="/credence/microservice/"
  --pubkey-format=pubkey-format  Public Key format pkcs8 or pkcs1 e.g --pubkey-format=pkcs8
  --pvtkey-format=pvtkey-format  Private key format pkcs8 or pkcs1 e.g --pvtkey-format=pkcs8

iwfcli migrate:encryption

Migrate existing microservice configurations to newer version. In this migration, any sensitive data will be encrypted using microservice/keys/ encryption key-pairs.

USAGE
  $ iwfcli migrate:encryption

iwfcli help [COMMAND]

Display help for iwfcli.

USAGE
  $ iwfcli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

How To

You can find video tutorial of commands here.

• iwfcli config:init

• iwfcli config:database

• iwfcli config:java

• iwfcli config:mq

• iwfcli config:port

• iwfcli config:product

• iwfcli info:system

• iwfcli extract:logs

• iwfcli create:threaddump

• iwfcli create:heapdump

• iwfcli generate:keys

• iwfcli migrate:encryption

Troubleshooting Tips

For any errors, reinitialize using iwfcli config:init command.