Skip to content

Commit

Permalink
Merge pull request #3452 from zowe/anax-v3-CLI-Usetab1-v3changes
Browse files Browse the repository at this point in the history
updating Use section content 1
  • Loading branch information
anaxceron authored Feb 23, 2024
2 parents fba1bf1 + 7ee8efe commit 02054c8
Show file tree
Hide file tree
Showing 9 changed files with 215 additions and 106 deletions.
10 changes: 10 additions & 0 deletions docs/appendix/zowe-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,12 @@ The Zowe Support Provider Conformance Program gives vendors the ability to showc

## Installation and configuration

#### Base profile

A type of team configuration profile that stores connection information for use with one or more services. Your service profiles can pull information from base profiles as needed, to specify a common username and password only once.

The base profile can optionally store tokens to connect to Zowe API Mediation Layer, which improves security by enabling Multi-Factor Authentication (MFA) and Single Sign-on (SSO).

#### Convenience build

The Zowe installation file for Zowe z/OS components that is distributed as a PAX file in z/OS Unix and contains the runtimes and scripts to install and launch the z/OS runtime. It is the most common method to install Zowe.
Expand All @@ -212,6 +218,10 @@ Use of z/OS UNIX services requires a z/OS UNIX security context, referred to as

The z/OS Unix directory for the [Zowe runtime](#zowe-runtime), specified in the Zowe configuration file via `zowe.runtimeDirectory`. Also the parent directory of the `zwe` command.

#### Service profile

A type of team configuration profile that stores connection information for a specific mainframe service, such as IBM z/OSMF. Plug-ins can introduce other service profile types, such as the CICS profile to connect to IBM CICS.

#### SMP/E

The Zowe installation for Zowe z/OS components that is distributed as an SMP/E package, identified by FMID, and contains the runtimes and the scripts to install and launch the z/OS runtime. The initial package is installed and then a PTF is applied. It is the second most common method to install Zowe.
Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide/cli-using-command-precedence.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ You can provide your mainframe connection details (username, password, etc.) to
When you issue a command, the CLI *searches* for your command arguments in the following order:

1. **Options** that you specify on individual commands.
2. **Environment variables** that you define in the computer's operating system.

For more information, see [Using environment variables](../user-guide/cli-using-using-environment-variables).
3. **Service profiles** that you create (i.e. z/OSMF profile or another mainframe service).
4. **Base profiles** that you create.
2. **Environment variables** that you define in the computer's operating system.

For more information, see [Using environment variables](../user-guide/cli-using-using-environment-variables).
3. **[Service profiles](../appendix/zowe-glossary.md#service-profile)** that you create (that is, a z/OSMF profile or another mainframe service).
4. **[Base profiles](appendix/zowe-glossary.md#base-profile)** that you create.
These can contain credentials for use with multiple services and/or an API ML login token.
5. **Default option value**.

Expand Down
33 changes: 22 additions & 11 deletions docs/user-guide/cli-using-displaying-help.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Displaying help

Zowe CLI has a command-line help system that details the commands, actions, and options available in the product.

## Top-level help

To view top-level help, open a command-line and issue the following command:
Expand All @@ -9,15 +10,21 @@ To view top-level help, open a command-line and issue the following command:
zowe --help
```

![Issuing the help command](../images/guides/CLI/GetHelp.gif)
- An example of the Zowe CLI response:

![Issuing the help command](../images/guides/CLI/GetHelp.gif)

Alternatively, issue the following command to display a full list of all available commands:
Alternatively, to display a full list of all available commands:

```
zowe --ac
```

**Tip:** All Zowe CLI commands begin with `zowe.`
:::tip

All Zowe CLI commands begin with `zowe`.

:::

## Group, action, and object help

Expand All @@ -29,9 +36,9 @@ For example, issue the following command to learn about the `create` action in t
zowe zos-files create --help
```

## Launch local web help
## Launching local web help

Launch an interactive form of help in a web browser. When you issue the following command, web help is custom-generated to include commands for all of your *currently installed* plug-ins:
Launch an interactive form of help content in a web browser. When you issue the following command, web help is custom-generated to include commands for all of your currently installed plug-ins:

```
zowe --help-web
Expand All @@ -42,12 +49,16 @@ Launching web help in browser...
PS C:\Users\myName>
```

**Tip:** Append `--help-web` to a specific command or action to launch directly into the appropriate web help page.
## Viewing web help
:::tip

Append `--help-web` to a specific command or action to launch directly into the appropriate web help page.

:::
## Viewing web help in other ways

We provide you with several methods to view Zowe CLI web help. You can browse Zowe CLI web help online, download the web help in a ZIP file that contains the HTML, or download the web help in a PDF file.
There are several methods to view Zowe CLI web help:

- <a href="/stable/web_help/index.html" target="_blank">Browse Online</a>
- <a href="/stable/zowe_web_help.zip" target="_blank">Download (ZIP)</a>
- <a href="/stable/CLIReference_Zowe.pdf" target="_blank">Download (PDF)</a>
- <a href="/stable/web_help/index.html" target="_blank">Use a web browser</a>
- <a href="/stable/zowe_web_help.zip" target="_blank">Extract from a ZIP file</a>
- <a href="/stable/CLIReference_Zowe.pdf" target="_blank">Download a PDF file</a>

10 changes: 8 additions & 2 deletions docs/user-guide/cli-using-issuing-first-command.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Issuing your first command

You can provide all connection options directly on commands to access a service. For example, issue the following command to list all data sets under the name `ibmuser` on the specified system:
Typically, users rely on [team configuration](../appendix/zowe-glossary.md#team-configuration) to connect to the mainframe and issue commands.

But if you have just installed Zowe CLI and have not yet configured your profiles, you can provide all connection options directly in the command line to access a service.

For example, issue the following command to list all data sets under the name `ibmuser` on the specified system:

```
zowe zos-files list data-set "ibmuser.*" --host host123 --port port123 --user ibmuser --password pass123
```

If you omit username, password, host, or port (and a value cannot be found in your configuration), the CLI prompts you to enter a value.
- If you omit username, password, host, or port, and a value cannot be found in your configuration, Zowe CLI prompts you to enter a value.

However, this is not the most efficient way to communicate with the mainframe. To avoid having to enter connection details with every command repeatedly, use team profiles.
Loading

0 comments on commit 02054c8

Please sign in to comment.