UNPKG

@zowe/cli

Version:

Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.

github.com/zowe/zowe-cli

zowe/zowe-cli

26 lines (15 loc) • 1.72 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Profile Guidelines This document explains the concept of user profiles in Zowe CLI/plug-ins. ## Purpose and Use Cases Profiles are simple documents (YAML format) intended to persist user configuration properties. The basic use case for a profile is to persist "connection details" (i.e. host/port & user credentials to a remote service). An analogy for profiles is "sessions" in Putty. Profiles are ultimately for user convenience. Having to repetitively type (or retype) sets of configuration/options can be cumbersome for a user. See [Imperative CLI Framework documentation](https://github.com/zowe/imperative/wiki) about profiles for details on implementing profiles and the profile "type" concept. ### When You Use a Profile to Store Configuration Items Use a profile to store configuration items under the following conditions: - You require information specific to the user (e.g. credentials). - You require Configuration/Options that are repetitive or required on every command for a group. - The configuration information that the user would want to swap on a per command basis (e.g. issuing commands to z/OSMF on SYSA, then again on SYSB would require different sets of "connection details") - The configuration information that apps built on Zowe CLI require. For example, a "Job Explorer" extension in VS Code would benefit from a user profile - no additional configuration would be required from the user for the extension to connect to a remote z/OSMF. ### When You Should Not Use Profiles to Store Configuration Items - Your profile requires a global configuration. That is, depending on the use case, the use of an environment variable might be more suitable for this type of configuration.