Skip to content

Commit 2af1111

Browse files
committed
chore: Added review comments.
1 parent 47ec8f3 commit 2af1111

1 file changed

Lines changed: 15 additions & 49 deletions

File tree

packages/site/src/content/get-started/patternfly-cli.mdx

Lines changed: 15 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-
1010

1111
## Features
1212

13-
- **Project scaffolding:** Quickly set up new projects with predefined templates.
14-
- **Code modifications:** Automate repetitive code changes.
15-
- **Task runner:** Execute project-related tasks efficiently.
13+
- **Project scaffolding:** Quickly set up new PatternFly based projects for development, and prototyping. This is done using predefined templates.
14+
- **Code modifications:** Automate repetitive code changes that helps users upgrade to the latest version of PatternFly.
15+
- **Task runner:** Execute project-related tasks efficiently, such as source code management and task running.
1616

17-
## Prerequisites
1817

19-
If you use the [install script](#install-script-macos-and-linux) on macOS or Linux, it covers the items below (you may still need administrator access for system packages). Otherwise, install the following yourself before using the CLI:
18+
## How do I setup PatternFly CLI?
19+
20+
### Prerequisites
21+
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:
2022

2123
- **[Node.js and npm](https://nodejs.org/)** (supported versions **20–24**) — also see [npm](https://www.npmjs.com/).
2224
- **[Corepack](https://nodejs.org/api/corepack.html)** — included with Node.js; enable with `corepack enable` after installing npm.
@@ -32,59 +34,27 @@ You can pipe the repository install script into `bash`. It installs Node.js with
3234
curl -fsSL https://raw.githubusercontent.com/patternfly/patternfly-cli/main/scripts/install.sh | bash
3335
```
3436

35-
Swap `main` for another branch or tag if you need a specific revision. To save the script and inspect it before running:
36-
37-
```sh
38-
curl -fsSL https://raw.githubusercontent.com/patternfly/patternfly-cli/main/scripts/install.sh -o install-patternfly-cli.sh
39-
bash install-patternfly-cli.sh
40-
```
41-
4237
The script may prompt for `sudo` when your system package manager installs GitHub CLI.
4338

44-
### npm
39+
### Windows Install
4540

46-
If you already have the [prerequisites](#prerequisites) on your machine, install the published package globally:
41+
After installing the [prerequisites](#prerequisites) on your machine, install the published package globally:
4742

4843
```sh
4944
npm install -g @patternfly/patternfly-cli
5045
```
5146

52-
## Uninstall
53-
54-
### Uninstall script (macOS and Linux)
55-
56-
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.
57-
58-
```sh
59-
curl -fsSL https://raw.githubusercontent.com/patternfly/patternfly-cli/main/scripts/uninstall.sh | bash
60-
```
61-
62-
Swap `main` for another branch or tag if you need a specific revision. To save the script and inspect it before running:
63-
64-
```sh
65-
curl -fsSL https://raw.githubusercontent.com/patternfly/patternfly-cli/main/scripts/uninstall.sh -o uninstall-patternfly-cli.sh
66-
bash uninstall-patternfly-cli.sh
67-
```
68-
69-
### npm
70-
71-
If you installed with npm globally, remove the package with:
72-
73-
```sh
74-
npm uninstall -g @patternfly/patternfly-cli
75-
```
76-
7747
## Usage
7848

79-
After installation, run:
49+
After installation, you can verify the latest version of the CLI has been installed by running the following in the termianl:
8050

8151
```sh
82-
patternfly-cli [command]
52+
patternfly-cli -v
8353
```
8454

85-
### Available commands
55+
### Available CLI commands
8656

87-
| Command | Description |
57+
| Command | Usage |
8858
| --- | --- |
8959
| `create` | Create a new project from the available templates. |
9060
| `list` | List all available templates (built-in and optional custom). |
@@ -95,9 +65,9 @@ patternfly-cli [command]
9565
| `load` | Pull the latest updates from GitHub. |
9666
| `deploy` | Build and deploy your app to GitHub Pages. |
9767

98-
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.
9969

100-
## Custom templates
70+
### Custom templates
10171

10272
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.
10373

@@ -132,7 +102,3 @@ patternfly-cli list --template-file ./my-templates.json
132102
- **`repo`** (required): Git clone URL.
133103
- **`options`** (optional): Array of extra arguments for `git clone` (e.g. `["--single-branch", "--branch", "main"]`).
134104
- **`packageManager`** (optional): `npm`, `yarn`, or `pnpm`; defaults to `npm` if omitted.
135-
136-
## Source and releases
137-
138-
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)