You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**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.
16
16
17
-
## Prerequisites
18
17
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:
20
22
21
23
-**[Node.js and npm](https://nodejs.org/)** (supported versions **20–24**) — also see [npm](https://www.npmjs.com/).
22
24
-**[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
The script may prompt for `sudo` when your system package manager installs GitHub CLI.
43
38
44
-
### npm
39
+
### Windows Install
45
40
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:
47
42
48
43
```sh
49
44
npm install -g @patternfly/patternfly-cli
50
45
```
51
46
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.
If you installed with npm globally, remove the package with:
72
-
73
-
```sh
74
-
npm uninstall -g @patternfly/patternfly-cli
75
-
```
76
-
77
47
## Usage
78
48
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:
80
50
81
51
```sh
82
-
patternfly-cli [command]
52
+
patternfly-cli -v
83
53
```
84
54
85
-
### Available commands
55
+
### Available CLI commands
86
56
87
-
| Command |Description|
57
+
| Command |Usage|
88
58
| --- | --- |
89
59
|`create`| Create a new project from the available templates. |
90
60
|`list`| List all available templates (built-in and optional custom). |
@@ -95,9 +65,9 @@ patternfly-cli [command]
95
65
|`load`| Pull the latest updates from GitHub. |
96
66
|`deploy`| Build and deploy your app to GitHub Pages. |
97
67
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.
99
69
100
-
## Custom templates
70
+
###Custom templates
101
71
102
72
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.
103
73
@@ -132,7 +102,3 @@ patternfly-cli list --template-file ./my-templates.json
132
102
-**`repo`** (required): Git clone URL.
133
103
-**`options`** (optional): Array of extra arguments for `git clone` (e.g. `["--single-branch", "--branch", "main"]`).
134
104
-**`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