# @credenceanalytics/iwfcli

> iwfcli ==========

Latest version **22.0.0** (published 2026-08-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @credenceanalytics/iwfcli
pnpm add @credenceanalytics/iwfcli
yarn add @credenceanalytics/iwfcli
bun add @credenceanalytics/iwfcli
```

Provides the command `iwfcli`.

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 22.0.0 |
| Published | 2026-08-20 |
| First published | 2022-01-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=18.17.0 |
| Dependencies | 18 |
| Unpacked size | 129.9 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | prabhuvikas, jimmyjammerx, suraj_chavan, cred-shubham, mohinim18, jiteshsuthar, mandakadam, prajaktacred, sagarf, shruti_shende, sonalnadkar, suhas_surwase |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@credenceanalytics/iwfcli
- Repository: https://gitlab.credenceanalytics.com/iwf/iwf-cli
- Homepage: https://www.npmjs.com/package/@credenceanalytics/iwfcli
- Issues: https://gitlab.credenceanalytics.com/iwf/iwf-cli/-/issues
- npm.io page: https://npm.io/package/@credenceanalytics/iwfcli

## Dependencies (18)

- [fs](https://npm.io/package/fs.md) ^0.0.1-security
- [os](https://npm.io/package/os.md) ^0.1.2
- [path](https://npm.io/package/path.md) ^0.12.7
- [util](https://npm.io/package/util.md) ^0.12.4
- [yaml](https://npm.io/package/yaml.md) ^1.10.2
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [dotenv](https://npm.io/package/dotenv.md) ^10.0.0
- [adm-zip](https://npm.io/package/adm-zip.md) ^0.5.16
- [winston](https://npm.io/package/winston.md) ^3.17.0
- [enquirer](https://npm.io/package/enquirer.md) ^2.4.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.0
- [node-rsa](https://npm.io/package/node-rsa.md) ^1.1.1
- [oracledb](https://npm.io/package/oracledb.md) ^5.5.0
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.17.0
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.8.0
- [check-disk-space](https://npm.io/package/check-disk-space.md) ^3.4.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^3.2.4

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 22.0.0 (latest) — 2026-08-20
- 3.3.1 — 2023-11-09
- 3.3.0 — 2023-04-20
- 3.2.0 — 2023-03-03
- 3.1.4 — 2023-02-24
- 3.0.4 — 2022-12-02
- 3.0.3 — 2022-09-01
- 3.0.2 — 2022-08-11
- 3.0.1 — 2022-07-28
- 3.0.0 — 2022-07-14
- 2.0.0 — 2022-03-31
- 1.1.0 — 2022-03-17
- 0.0.8 — 2022-01-22
- 0.0.7 — 2022-01-22
- 0.0.6 — 2022-01-22
- … 6 more at https://npm.io/package/@credenceanalytics/iwfcli/versions

## README

# iwfcli

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://www.npmjs.com/package/@credenceanalytics/iwfcli) [![Version](https://img.shields.io/npm/v/@credenceanalytics/iwfcli.svg)](https://www.npmjs.com/package/@credenceanalytics/iwfcli) [![Downloads/week](https://img.shields.io/badge/node-%3E=22.17.1-blue.svg?style=flat-square)](https://nodejs.org/download/release/v22.17.1/)

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 22.17.1 or higher and Oracle Instant Client version 18.5.0.0 for proper functioning.

# Installation

## Prerequisites
`iwfcli` installation need:
- Node.js >=22.17.1 ([*Download Link*](https://nodejs.org/download/release/v22.17.1/)) installed.
- Oracle Instant Client == 18.5.0.0 ([*Download Link*](https://www.oracle.com/in/database/technologies/instant-client/downloads.html)) installed.

### Online Mode

- `iwfcli` is available in npm. To install it, type:
  ```bash
  $ npm i -g @credenceanalytics/iwfcli
  ```

  [*See how*](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/iwfcli_installation.mp4)

### Offline Mode

- Extract [iwfcli.zip](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/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*)

  ![img](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/iwfcli_install_img.jpg)

- Test installation by typing following command:
  ```bash
  $ 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](#iwfcli-configinit) command.
Sensitive data encryption is now supported.

```
USAGE
  Basic Command
  $ iwfcli config:database

  With Options
  $ iwfcli config:database --username <DB_USER_NAME> --password <DB_PASSWORD> --host <DB_HOST> --port <DB_PORT> --sid <DB_SERVICE_ID> --encrypt <true/false>

```

## `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
  Basic Command
  $ iwfcli config:mq

  With Options
  $ iwfcli config:mq --username <RABBITMQ_USER_NAME> --password <RABBITMQ_PASSWORD> --host <RABBITMQ_HOST> --port <RABBITMQ_PORT> --enable-ssl <true/false>  --encrypt <true/false>

```

## `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`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/config_init.mp4)

- [`iwfcli config:database`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/V2/config_database.mp4)

- [`iwfcli config:java`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/config_java.mp4)

- [`iwfcli config:mq`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/V2/config_mq.mp4)

- [`iwfcli config:port`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/config_port.mp4)

- [`iwfcli config:product`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/V2/config_product.mp4)

- [`iwfcli info:system`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/info_system.mp4)

- [`iwfcli extract:logs`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/extract_logs.mp4)

- [`iwfcli create:threaddump`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/create_threaddump.webm)
 
- [`iwfcli create:heapdump`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/create_heapdump.mp4)

- [`iwfcli generate:keys`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/V2/generate_keys.mp4)

- [`iwfcli migrate:encryption`](https://cred-iwf.s3.ap-south-1.amazonaws.com/cli/How+To/V2/migrate_encryption.mp4)

# Troubleshooting Tips

For any errors, reinitialize using [iwfcli config:init](#iwfcli-configinit) command.

---
_Source: https://npm.io/package/@credenceanalytics/iwfcli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
