{"_id":"@credenceanalytics/cashtreacli","_rev":"2-a3d5378004f3baa44bdcb1573ad14426","name":"@credenceanalytics/cashtreacli","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@credenceanalytics/cashtreacli","version":"1.0.0","keywords":["oclif"],"author":{"name":"Credence Analytics"},"license":"MIT","_id":"@credenceanalytics/cashtreacli@1.0.0","maintainers":[{"name":"prabhuvikas","email":"vikasprabhu@credenceanalytics.com"},{"name":"jimmyjammerx","email":"pratiksatardekar@credenceanalytics.com"},{"name":"suraj_chavan","email":"surajchavan@credenceanalytics.com"},{"name":"cred-shubham","email":"shubhamyadav@credenceanalytics.com"},{"name":"mohinim18","email":"mohinimemane@credenceanalytics.com"},{"name":"jiteshsuthar","email":"jiteshsuthar@credenceanalytics.com"},{"name":"mandakadam","email":"mandakadam@credenceanalytics.com"},{"name":"prajaktacred","email":"prajaktashinde@credenceanalytics.com"},{"name":"sagarf","email":"sagarfernandes@credenceanalytics.com"},{"name":"shruti_shende","email":"shrutishende@credenceanalytics.com"},{"name":"sonalnadkar","email":"sonalnadkar@credenceanalytics.com"},{"name":"suhas_surwase","email":"suhassurwase@credenceanalytics.com"}],"homepage":"https://www.npmjs.com/package/@credenceanalytics/cashtreacli","bugs":{"url":"https://gitlab.credenceanalytics.com/cashtrea-web/development/backend-apps/cashtrea-cli/-/issues"},"bin":{"cashtreacli":"bin/run.js"},"dist":{"shasum":"cc5eb47da8a5fb4be9532881f6484b06780bae77","tarball":"https://registry.npmjs.org/@credenceanalytics/cashtreacli/-/cashtreacli-1.0.0.tgz","fileCount":74,"integrity":"sha512-Fa6988qGzIoV/Q+xrRwTtYcZLpbr2Ctw7Ar32/qOE9d9XimYoHvkNz7u5beZtGVRM0dCOzbh0huTHz/+6nsuLA==","signatures":[{"sig":"MEQCIGlj6huNGM/3avmxMsK1fgqP2Y4GrjnxR9YeNeXzLWPLAiBE5sn6Yr1W2+1Ua6YUbwVrHjxMr7lRmlnYzUHR64Idlw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":428402},"oclif":{"bin":"cashtreacli","topics":{"info":{"description":"Show system and deployment information"},"config":{"description":"Configure the installed CashTrea services"}},"dirname":"cashtreacli","plugins":["@oclif/plugin-help"],"commands":"./dist/commands","topicSeparator":":"},"engines":{"node":">=18.0.0"},"gitHead":"7dbb0320a954a8ca01a19ccc8d1e5304ea6feeba","scripts":{"build":"npm run clean && tsc -b","clean":"rimraf dist oclif.manifest.json","prepare":"node -e \"require('fs').existsSync('tsconfig.json') && require('child_process').execSync('npm run build && oclif manifest',{stdio:'inherit'})\"","manifest":"oclif manifest","postpack":"rimraf oclif.manifest.json","typecheck":"tsc -p tsconfig.typecheck.json","bundle:offline":"node scripts/build-offline.js"},"_npmUser":{"name":"suhas_surwase","email":"suhassurwase@credenceanalytics.com"},"repository":{"url":"https://gitlab.credenceanalytics.com/cashtrea-web/development/backend-apps/cashtrea-cli","type":"git"},"_npmVersion":"10.8.2","description":"CashTrea deployment configuration and field-support CLI","directories":{},"_nodeVersion":"22.22.2","dependencies":{"adm-zip":"^0.5.16","winston":"^3.14.0","oracledb":"^5.5.0","@oclif/core":"^4.0.0","fast-xml-parser":"^4.5.0","@inquirer/prompts":"^5.5.0","@oclif/plugin-help":"^6.2.0"},"_hasShrinkwrap":false,"devDependencies":{"oclif":"^4.14.0","rimraf":"^5.0.9","ts-node":"^10.9.2","typescript":"^5.5.0","@types/node":"^20.14.0","@types/adm-zip":"^0.5.5","@types/oracledb":"^5.3.1"},"_npmOperationalInternal":{"tmp":"tmp/cashtreacli_1.0.0_1786518981700_0.48077977645007564","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-08-12T07:16:21.501Z","modified":"2026-09-21T10:50:47.462Z","1.0.0":"2026-08-12T07:16:21.868Z"},"bugs":{"url":"https://gitlab.credenceanalytics.com/cashtrea-web/development/backend-apps/cashtrea-cli/-/issues"},"author":{"name":"Credence Analytics"},"license":"MIT","homepage":"https://www.npmjs.com/package/@credenceanalytics/cashtreacli","keywords":["oclif"],"repository":{"url":"https://gitlab.credenceanalytics.com/cashtrea-web/development/backend-apps/cashtrea-cli","type":"git"},"description":"CashTrea deployment configuration and field-support CLI","maintainers":[{"email":"vikasprabhu@credenceanalytics.com","name":"prabhuvikas"},{"email":"surajchavan@credenceanalytics.com","name":"suraj_chavan"},{"email":"mohinimemane@credenceanalytics.com","name":"mohinim18"},{"email":"jiteshsuthar@credenceanalytics.com","name":"jiteshsuthar"},{"email":"mandakadam@credenceanalytics.com","name":"mandakadam"},{"email":"sonalnadkar@credenceanalytics.com","name":"sonalnadkar"},{"email":"suhassurwase@credenceanalytics.com","name":"suhas_surwase"}],"readme":"# cashtreacli\r\n\r\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://www.npmjs.com/package/@credenceanalytics/cashtreacli) [![Version](https://img.shields.io/npm/v/@credenceanalytics/cashtreacli.svg)](https://www.npmjs.com/package/@credenceanalytics/cashtreacli) [![Node](https://img.shields.io/badge/node-%3E=18.0.0-blue.svg?style=flat-square)](https://nodejs.org/download/release/latest-v18.x/)\r\n\r\nDeployment configuration and field-support CLI for the CashTrea / IDEAL stack.\r\n\r\nRun it **on the server**, after the product has been installed. It asks once for a\r\nset of details — Oracle, RabbitMQ, ports — and writes them into every service's own\r\nconfig file, in that service's own format and key names.\r\n\r\nFor implementation and support engineers, not end users.\r\n\r\n# Installation\r\n\r\n## Prerequisites\r\n\r\n`cashtreacli` installation needs:\r\n\r\n- Node.js >= 18.0.0 ([*Download Link*](https://nodejs.org/download/release/latest-v18.x/)) installed.\r\n- Oracle Instant Client, 64-bit ([*Download Link*](https://www.oracle.com/database/technologies/instant-client/downloads.html)) installed and on `PATH`, or set `ORACLE_CLIENT_LIB_DIR` to its directory.\r\n\r\n> Oracle Instant Client is **required**, not optional. Without it every database\r\n> connection fails with `DPI-1047` before it reaches the server.\r\n\r\n### Online Mode\r\n\r\n- `cashtreacli` is available in npm. To install it, type:\r\n ```bash\r\n $ npm i -g @credenceanalytics/cashtreacli\r\n ```\r\n\r\n- Test installation by typing following command:\r\n ```bash\r\n $ cashtreacli --help\r\n ```\r\n\r\n### Offline Mode\r\n\r\nFor servers with no access to the npm registry.\r\n\r\n- Extract [cashtreacli.zip](https://cred-cashtrea.s3.ap-south-1.amazonaws.com/cli/cashtreacli.zip).\r\n Place the extracted `cashtreacli` folder somewhere safe on your disk.\r\n\r\n- Run `npm link --force` inside the `cashtreacli` folder. (*This will start the\r\n installation process*)\r\n\r\n- Test installation by typing following command:\r\n ```bash\r\n $ cashtreacli --help\r\n ```\r\n\r\nThe bundle carries its own dependencies, so nothing is downloaded. It works on\r\nLinux, Windows and macOS (x64) from the same zip. Oracle Instant Client is still\r\nrequired separately — it is not part of this bundle.\r\n\r\n# Commands\r\n\r\nCommands accept optional parameters. If no options are provided, the command\r\nprompts interactively for the information it needs.\r\n\r\n**Start with `config:init`.** Every other command reads the service paths it\r\nrecords. After any change, run `doctor` to confirm what landed.\r\n\r\n## `cashtreacli config:init`\r\n\r\nDetect the installed CashTrea services, confirm where each one lives, and store\r\nthe paths. Run this first, and again whenever a service moves.\r\n\r\n```\r\nUSAGE\r\n $ Basic Command\r\n cashtreacli config:init\r\n\r\n $ With Options\r\n cashtreacli config:init --root --relocate --replace --set =\r\n```\r\n\r\n## `cashtreacli config:database`\r\n\r\nSet the Oracle connection details across every installed service. The connection\r\nis verified before anything is written. For any errors reinitialize using\r\n[cashtreacli config:init](#cashtreacli-configinit) command.\r\n\r\n```\r\nUSAGE\r\n $ Basic Command\r\n cashtreacli config:database\r\n\r\n $ With Options\r\n cashtreacli config:database --user --password --host --port --sid --skip-check\r\n```\r\n\r\n## `cashtreacli config:mq`\r\n\r\nSet the RabbitMQ connection details across every installed service.\r\n\r\n```\r\nUSAGE\r\n $ Basic Command\r\n cashtreacli config:mq\r\n\r\n $ With Options\r\n cashtreacli config:mq --user --password --host --port --exchange --queue \r\n```\r\n\r\n## `cashtreacli config:port`\r\n\r\nShow or change service ports, keeping the matching nginx upstreams in step.\r\n\r\n```\r\nUSAGE\r\n $ Show current ports\r\n cashtreacli config:port --show\r\n\r\n $ Change a port\r\n cashtreacli config:port --set =\r\n```\r\n\r\n## `cashtreacli doctor`\r\n\r\nRead-only health check. Reports configuration drift between services, broken\r\nwiring, and nginx upstreams with nothing behind them. Changes nothing.\r\n\r\n```\r\nUSAGE\r\n $ Basic Command\r\n cashtreacli doctor\r\n```\r\n\r\n`--db` additionally opens a connection with each service's configured\r\ncredentials.\r\n\r\n## `cashtreacli info:system`\r\n\r\nShow host information — CPU, memory, disk and OS.\r\n\r\n```\r\nUSAGE\r\n $ Basic Command\r\n cashtreacli info:system\r\n\r\n $ With Options\r\n cashtreacli info:system --json --verbose\r\n```\r\n\r\n## `cashtreacli help [COMMAND]`\r\n\r\nDisplay help for cashtreacli.\r\n\r\n```\r\nUSAGE\r\n $ cashtreacli help [COMMAND]\r\n```\r\n\r\n# Before You Run It\r\n\r\nThis tool rewrites live configuration. Two things to know:\r\n\r\n- **There is no preview.** `config:*` commands write as soon as they have their\r\n answers. Run `cashtreacli doctor` first to see what is there, and again\r\n afterwards to see what landed.\r\n- **Commands exit 0 even on failure**, and print a single line. Read the output;\r\n do not rely on the exit code in a script. `doctor` is the exception — it exits\r\n non-zero when a check fails.\r\n\r\nThe CLI never restarts anything. Bounce pm2, WildFly or `nginx -s reload`\r\nyourself once a change is written.\r\n\r\n# Troubleshooting Tips\r\n\r\n| Symptom | What to do |\r\n|---|---|\r\n| `DPI-1047: Cannot locate a 64-bit Oracle Client library` | Install Oracle Instant Client and put it on `PATH`, or set `ORACLE_CLIENT_LIB_DIR`. |\r\n| A service is missing, or its path is wrong | Reinitialize using [cashtreacli config:init](#cashtreacli-configinit). |\r\n| `cannot reach :` | The database address is not routable from this machine — a private (`10.x`) address cannot be reached from outside its network. |\r\n\r\n# License\r\n\r\nMIT — see [LICENSE](./LICENSE).\r\n","readmeFilename":"README.md"}