framework for building configurable CLIs
npm install @zowe/imperative

Imperative CLI Framework is a command processing system that lets you quickly build customized command-line interfaces. Focus on adding functionality for your users rather than creating CLI infrastructure. We provide you with all the tools to get started building your own CLI plug-ins.
- Install Node.js package manager on your computer. Node.jsĀ® is a JavaScript runtime environment on which we architected Imperative CLI Framework.
- You must have a means to execute ".sh" (bash) scripts to run integration tests. On Windows, you can install "Git Bash", which is bundled with the standard Git installation - (choose the "Use Git and Unix Tools from Windows Command Prompt" installation option). When you run the integration tests on Windows, you must have Administrative authority to enable the integration tests to create symbolic links.
Note: Broadcom Inc. does not maintain the prerequisite software that Imperative CLI Framework requires. You are responsible for updating Node.js and other prerequisites on your computer. We recommend that you update Node.js regularly to the latest Long Term Support (LTS) version.
Issue the following commands to install Imperative CLI Framework as a dependency.
- Install @latest version:
Be aware that if you update via @latest, you accept breaking changes into your project.
`` bash`
npm install @zowe/imperative
- Install @zowe-v2-lts version:
This is a Long Term Support release that is guaranteed to have no breaking changes.
` bash`
npm install @zowe/imperative@zowe-v2-lts
Note: If you want to install the bleeding edge version of Imperative, you can append --@zowe:registry=https://zowe.jfrog.io/zowe/api/npm/npm-release/ to the install command to get it from a staging registry. It is not recommended to use this registry for production dependencies.
1. Clone the zowe/imperative project to your PC.cd [relative path]/imperative
2. From the command line, issue npm install
3. Issue npm run build
4. Issue npm run test
5. Issue
To build the entire project (including test stand-alone CLIs):
npm run build
To build only imperative source:
npm run build:packages
| Run all automated tests (unit & integration)
npm test:unit | Run unit tests
npm test:integration | Run integration tests
npm test:system | Run system tests (requires IPv6 connection)Note: To build and install the test CLIs used by the integration tests:
1.
node scripts/sampleCliTool.js build
2. node scripts/sampleCliTool.js install`We provide a sample plug-in that you can use to get started developing your own plug-ins. See the Zowe CLI Sample Plug-in.