Skip to content

Commit 47ec8f3

Browse files
committed
chore: Added review comments.
1 parent 311103c commit 47ec8f3

1 file changed

Lines changed: 5 additions & 33 deletions

File tree

packages/documentation-site/patternfly-docs/content/get-started/patternfly-cli.md

Lines changed: 5 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-
1515
- **Task runner:** Execute project-related tasks efficiently, such as source code management and task running.
1616

1717

18-
## Prerequisites
18+
## How do I setup PatternFly CLI?
1919

20+
### Prerequisites
2021
Prerequistes can be found below. For macOS, WSL, and Linux it is recommended that you use [install script](#install-script-macos-and-linux), it covers the items below (you may still need administrator access for system packages). Window based system you will need to install the following yourself before using the CLI:
2122

2223
- **[Node.js and npm](https://nodejs.org/)** (supported versions **20–24**) — also see [npm](https://www.npmjs.com/).
@@ -43,31 +44,6 @@ The script may prompt for `sudo` when your system package manager installs GitHu
4344
npm install -g @patternfly/patternfly-cli
4445
```
4546

46-
## Uninstall
47-
48-
### Uninstall script (macOS and Linux)
49-
50-
If you ever wish to uninstall PatternFly Cli, you can do the following. Pipe the repository uninstall script into `bash`. It removes the globally installed `@patternfly/patternfly-cli` package with npm. It does **not** remove Node.js, nvm, Corepack, or GitHub CLI.
51-
52-
```sh
53-
curl -fsSL https://raw.githubusercontent.com/patternfly/patternfly-cli/main/scripts/uninstall.sh | bash
54-
```
55-
56-
Swap `main` for another branch or tag if you need a specific revision. To save the script and inspect it before running:
57-
58-
```sh
59-
curl -fsSL https://raw.githubusercontent.com/patternfly/patternfly-cli/main/scripts/uninstall.sh -o uninstall-patternfly-cli.sh
60-
bash uninstall-patternfly-cli.sh
61-
```
62-
63-
### Windows npm package uninstall
64-
65-
If you installed the CLI on Windows, you can remove the CLI with:
66-
67-
```sh
68-
npm uninstall -g @patternfly/patternfly-cli
69-
```
70-
7147
## Usage
7248

7349
After installation, you can verify the latest version of the CLI has been installed by running the following in the termianl:
@@ -78,7 +54,7 @@ patternfly-cli -v
7854

7955
### Available CLI commands
8056

81-
| Command | Description |
57+
| Command | Usage |
8258
| --- | --- |
8359
| `create` | Create a new project from the available templates. |
8460
| `list` | List all available templates (built-in and optional custom). |
@@ -89,9 +65,9 @@ patternfly-cli -v
8965
| `load` | Pull the latest updates from GitHub. |
9066
| `deploy` | Build and deploy your app to GitHub Pages. |
9167

92-
For the most up-to-date flags and behavior, see the [PatternFly CLI README](https://github.com/patternfly/patternfly-cli/blob/main/README.md) on GitHub.
68+
For the most up-to-date flags and behavior guidance, refer to [PatternFly CLI README](https://github.com/patternfly/patternfly-cli/blob/main/README.md) on GitHub.
9369

94-
## Custom templates
70+
### Custom templates
9571

9672
You can add your own templates in addition to the built-in ones by passing a JSON file with `--template-file` (or `-t`). Custom templates are merged with the built-in list; if a custom template has the same `name` as a built-in one, the custom definition is used.
9773

@@ -126,7 +102,3 @@ patternfly-cli list --template-file ./my-templates.json
126102
- **`repo`** (required): Git clone URL.
127103
- **`options`** (optional): Array of extra arguments for `git clone` (e.g. `["--single-branch", "--branch", "main"]`).
128104
- **`packageManager`** (optional): `npm`, `yarn`, or `pnpm`; defaults to `npm` if omitted.
129-
130-
## Source and releases
131-
132-
The CLI is developed in the open at [github.com/patternfly/patternfly-cli](https://github.com/patternfly/patternfly-cli). Report issues or contribute there; release notes and tags are published on the repository’s [Releases](https://github.com/patternfly/patternfly-cli/releases) page.

0 commit comments

Comments
 (0)