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
Copy file name to clipboardExpand all lines: packages/documentation-site/patternfly-docs/content/get-started/patternfly-cli.md
+5-33Lines changed: 5 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,8 +15,9 @@ The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-
15
15
-**Task runner:** Execute project-related tasks efficiently, such as source code management and task running.
16
16
17
17
18
-
## Prerequisites
18
+
## How do I setup PatternFly CLI?
19
19
20
+
### Prerequisites
20
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:
21
22
22
23
-**[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
43
44
npm install -g @patternfly/patternfly-cli
44
45
```
45
46
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.
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
-
71
47
## Usage
72
48
73
49
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
78
54
79
55
### Available CLI commands
80
56
81
-
| Command |Description|
57
+
| Command |Usage|
82
58
| --- | --- |
83
59
|`create`| Create a new project from the available templates. |
84
60
|`list`| List all available templates (built-in and optional custom). |
@@ -89,9 +65,9 @@ patternfly-cli -v
89
65
|`load`| Pull the latest updates from GitHub. |
90
66
|`deploy`| Build and deploy your app to GitHub Pages. |
91
67
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.
93
69
94
-
## Custom templates
70
+
###Custom templates
95
71
96
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.
97
73
@@ -126,7 +102,3 @@ patternfly-cli list --template-file ./my-templates.json
126
102
-**`repo`** (required): Git clone URL.
127
103
-**`options`** (optional): Array of extra arguments for `git clone` (e.g. `["--single-branch", "--branch", "main"]`).
128
104
-**`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