From 113709f544532b32b3a33987cf655991e68a032d Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Mon, 11 May 2026 12:55:03 -0400 Subject: [PATCH 01/13] feat: added documentation for patternfly cli. --- .../developer-guides/patternfly-cli.md | 102 ++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md diff --git a/packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md new file mode 100644 index 0000000000..f0d4756fa1 --- /dev/null +++ b/packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md @@ -0,0 +1,102 @@ +--- +id: PatternFly CLI +title: PatternFly CLI +section: developer-guides +--- + +The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-line tool for scaffolding projects, performing code modifications, and running project-related tasks. It aims to streamline development workflows and improve productivity. The published package is [`@patternfly/patternfly-cli` on npm](https://www.npmjs.com/package/@patternfly/patternfly-cli). + +## What does the PatternFly CLI help with? + +- **Project scaffolding:** Quickly set up new PatternFly based projects for development and prototyping via predefined templates. +- **Code modifications:** Automate repetitive code changes to help accelerate PatternFly version upgrades. +- **Task runner:** Execute project-related tasks efficiently, such as source code management and task running. + + +## How do I set up PatternFly CLI? + +### Prerequisites +There are a few key prerequisites to meet before using PatternFly CLI. For macOS, WSL, and Linux, we recommend using [install script](#install-script-macos-and-linux) to address the following prerequisites (you might still need administrator access for system packages). For a Windows-based system, you will need to install the following items manually: + +- **[Node.js](https://nodejs.org/)** (Supported versions: 20–24) and **[npm](https://www.npmjs.com/)** +- **[Corepack](https://nodejs.org/api/corepack.html)** (Included with Node.js and enabled via `corepack enable` after installing npm) +- **[GitHub CLI](https://cli.github.com/)** (`gh`) + +## Installation + +### Install script (macOS and Linux) + +You can pipe the repository install script into `bash`. This installs Node.js with [nvm](https://github.com/nvm-sh/nvm) when `node` is not available, enables Corepack, installs GitHub CLI when it is missing, and installs the CLI globally from npm: + +```sh +curl -fsSL https://raw.githubusercontent.com/patternfly/patternfly-cli/main/scripts/install.sh | bash +``` + +The script might prompt you to include `sudo` when your system package manager installs GitHub CLI. + +### Windows + +After installing the [prerequisites](#prerequisites) on your machine, install the published package globally: + +```sh +npm install -g @patternfly/patternfly-cli +``` + +## How do I use PatternFly CLI? + +After installation, you can verify the latest version of the CLI has been installed by running the following terminal command: + +```sh +pfcli --version +``` + +### Available CLI commands +Once the PatternFly CLI is installed, you can run the following commands via `patternfly-cli [command]`: +| Command | Usage | +| --- | --- | +| `create` | Create a new project from the available templates. | +| `list` | List all available templates (built-in and optional custom). | +| `update` | Update your project to a newer version. | +| `cli-upgrade` | Upgrade the globally installed CLI to the latest npm release. It runs `npm install -g @patternfly/patternfly-cli@latest`—use your package manager’s equivalent if you did not install with npm. | +| `init` | Initialize a git repository and optionally create a GitHub repository. | +| `save` | Commit and push changes to the current branch. | +| `load` | Pull the latest updates from GitHub. | +| `deploy` | Build and deploy your app to GitHub Pages. | + +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. + +### Custom templates + +In addition to the built-in templates, you can add your own templates 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 template, the custom definition is used. + +**Create a project based on custom templates:** + +```sh +pfcli create my-app --template-file ./my-templates.json +``` + +**List templates included in custom file:** + +```sh +pfcli list --template-file ./my-templates.json +``` + +**JSON format** (Array of template objects, shown in the same shape as the built-in templates): + +```json +[ + { + "name": "my-template", + "description": "My custom project template", + "repo": "https://github.com/org/repo.git", + "options": ["--single-branch", "--branch", "main"], + "packageManager": "npm" + } +] +``` + +- **`name`** (required): Template identifier +- **`description`** (required): Short description shown in prompts and `list` +- **`repo`** (required): Git clone URL +- **`options`** (optional): Array of extra arguments for `git clone` (such as `["--single-branch", "--branch", "main"]`) +- **`packageManager`** (optional): `npm`, `yarn`, or `pnpm`; defaults to `npm` if omitted From 10229ed74d16a50f179188400ef08a3d697c6587 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Mon, 11 May 2026 13:55:53 -0400 Subject: [PATCH 02/13] chore: updated with comments from team. --- .../{developer-guides => AI}/patternfly-cli.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) rename packages/documentation-site/patternfly-docs/content/{developer-guides => AI}/patternfly-cli.md (84%) diff --git a/packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md similarity index 84% rename from packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md rename to packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index f0d4756fa1..1e649a9c65 100644 --- a/packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -1,10 +1,12 @@ --- id: PatternFly CLI title: PatternFly CLI -section: developer-guides +section: AI --- -The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-line tool for scaffolding projects, performing code modifications, and running project-related tasks. It aims to streamline development workflows and improve productivity. The published package is [`@patternfly/patternfly-cli` on npm](https://www.npmjs.com/package/@patternfly/patternfly-cli). +The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-line tool for scaffolding projects, performing code modifications, and running project-related tasks. It streamlines everyday development work and PatternFly upgrades. You can run it in the terminal on its own, or use it from an **AI-enabled editor** (for example [Cursor](https://www.cursor.com/)) so coding agents rely on the same predictable commands for scaffolding, updates, and git workflows. The published package is [`@patternfly/patternfly-cli` on npm](https://www.npmjs.com/package/@patternfly/patternfly-cli). + +The npm package installs two equivalent entry points: `patternfly-cli` and the shorter alias `pfcli`. The examples below use `patternfly-cli`; substitute `pfcli` if you prefer. ## What does the PatternFly CLI help with? @@ -47,7 +49,7 @@ npm install -g @patternfly/patternfly-cli After installation, you can verify the latest version of the CLI has been installed by running the following terminal command: ```sh -pfcli --version +patternfly-cli --version ``` ### Available CLI commands @@ -72,13 +74,13 @@ In addition to the built-in templates, you can add your own templates by passing **Create a project based on custom templates:** ```sh -pfcli create my-app --template-file ./my-templates.json +patternfly-cli create my-app --template-file ./my-templates.json ``` **List templates included in custom file:** ```sh -pfcli list --template-file ./my-templates.json +patternfly-cli list --template-file ./my-templates.json ``` **JSON format** (Array of template objects, shown in the same shape as the built-in templates): From 2a4b164647bbb7e8dea7f97d609886d8e3a12d2c Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Mon, 11 May 2026 16:25:31 -0400 Subject: [PATCH 03/13] Update packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> --- .../patternfly-docs/content/AI/patternfly-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index 1e649a9c65..6f059e438b 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -4,7 +4,7 @@ title: PatternFly CLI section: AI --- -The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-line tool for scaffolding projects, performing code modifications, and running project-related tasks. It streamlines everyday development work and PatternFly upgrades. You can run it in the terminal on its own, or use it from an **AI-enabled editor** (for example [Cursor](https://www.cursor.com/)) so coding agents rely on the same predictable commands for scaffolding, updates, and git workflows. The published package is [`@patternfly/patternfly-cli` on npm](https://www.npmjs.com/package/@patternfly/patternfly-cli). +The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-line tool for scaffolding projects, performing code modifications, and running project-related tasks. It streamlines everyday development work and PatternFly upgrades, making it convenient and easy to work straight from the terminal. You can run it in the terminal on its own, or use it from an AI-enabled editor (such as [Cursor](https://www.cursor.com/)) so coding agents can rely on the same predictable commands for scaffolding, updates, and git workflows. The published package is [`@patternfly/patternfly-cli` on npm](https://www.npmjs.com/package/@patternfly/patternfly-cli). The npm package installs two equivalent entry points: `patternfly-cli` and the shorter alias `pfcli`. The examples below use `patternfly-cli`; substitute `pfcli` if you prefer. From a24d088fa83ebfdad88a7f50ccedbdb905971251 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Mon, 11 May 2026 16:26:00 -0400 Subject: [PATCH 04/13] Update packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> --- .../patternfly-docs/content/AI/patternfly-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index 6f059e438b..4c7e33adba 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -12,7 +12,7 @@ The npm package installs two equivalent entry points: `patternfly-cli` and the s - **Project scaffolding:** Quickly set up new PatternFly based projects for development and prototyping via predefined templates. - **Code modifications:** Automate repetitive code changes to help accelerate PatternFly version upgrades. -- **Task runner:** Execute project-related tasks efficiently, such as source code management and task running. +- **Task execution:** Run project-related tasks such as committing and pushing changes, pulling updates, and deploying your app to GitHub Pages. ## How do I set up PatternFly CLI? From f4d07e254c2ae41ceb579835aafaab9bdd769e68 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Mon, 11 May 2026 20:29:47 -0400 Subject: [PATCH 05/13] fix: updated with review comments. --- .../content/AI/patternfly-cli.md | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index 4c7e33adba..49070e9748 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -54,6 +54,7 @@ patternfly-cli --version ### Available CLI commands Once the PatternFly CLI is installed, you can run the following commands via `patternfly-cli [command]`: + | Command | Usage | | --- | --- | | `create` | Create a new project from the available templates. | @@ -67,6 +68,18 @@ Once the PatternFly CLI is installed, you can run the following commands via `pa 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. +### Predefined templates + +Built-in templates ship with the CLI. Each row is the template `name` you pass to `patternfly-cli create` (or choose from the interactive prompt). To print the list from your installed version, run `patternfly-cli list`. + +| Template name | Description | +| --- | --- | +| `starter` | Starter template for a PatternFly React TypeScript project | +| `compass-starter` | Starter template for a PatternFly Compass theme TypeScript project | +| `nextjs-starter` | Starter template for a PatternFly Next.js project | + +Template definitions in source: [patternfly-cli `src/templates.ts`](https://github.com/patternfly/patternfly-cli/blob/main/src/templates.ts). + ### Custom templates In addition to the built-in templates, you can add your own templates 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 template, the custom definition is used. @@ -102,3 +115,21 @@ patternfly-cli list --template-file ./my-templates.json - **`repo`** (required): Git clone URL - **`options`** (optional): Array of extra arguments for `git clone` (such as `["--single-branch", "--branch", "main"]`) - **`packageManager`** (optional): `npm`, `yarn`, or `pnpm`; defaults to `npm` if omitted + +## Uninstalling PatternFly CLI + +### Uninstall script (macOS and Linux) + +You can 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: + +```sh +curl -fsSL https://raw.githubusercontent.com/patternfly/patternfly-cli/main/scripts/uninstall.sh | bash +``` + +### Windows + +If you installed the published package globally with npm, remove it with: + +```sh +npm uninstall -g @patternfly/patternfly-cli +``` From 58cd3aca52211923804ddf9e45bad7d7010f4c44 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Mon, 11 May 2026 20:56:10 -0400 Subject: [PATCH 06/13] chore: updated with additional review comments. --- .../patternfly-docs/content/AI/patternfly-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index 49070e9748..cb1fef0d4f 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -59,7 +59,7 @@ Once the PatternFly CLI is installed, you can run the following commands via `pa | --- | --- | | `create` | Create a new project from the available templates. | | `list` | List all available templates (built-in and optional custom). | -| `update` | Update your project to a newer version. | +| `update` | Migrate your project to a newer PatternFly version using codemods, which handle import changes, component renames, and other breaking changes automatically.| | `cli-upgrade` | Upgrade the globally installed CLI to the latest npm release. It runs `npm install -g @patternfly/patternfly-cli@latest`—use your package manager’s equivalent if you did not install with npm. | | `init` | Initialize a git repository and optionally create a GitHub repository. | | `save` | Commit and push changes to the current branch. | From ff6bbd29eab2560e393809eb27553a004d93e0f1 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Mon, 11 May 2026 20:59:01 -0400 Subject: [PATCH 07/13] chore: prereq. section. --- .../patternfly-docs/content/AI/patternfly-cli.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index cb1fef0d4f..31507e38cc 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -20,9 +20,9 @@ The npm package installs two equivalent entry points: `patternfly-cli` and the s ### Prerequisites There are a few key prerequisites to meet before using PatternFly CLI. For macOS, WSL, and Linux, we recommend using [install script](#install-script-macos-and-linux) to address the following prerequisites (you might still need administrator access for system packages). For a Windows-based system, you will need to install the following items manually: -- **[Node.js](https://nodejs.org/)** (Supported versions: 20–24) and **[npm](https://www.npmjs.com/)** -- **[Corepack](https://nodejs.org/api/corepack.html)** (Included with Node.js and enabled via `corepack enable` after installing npm) -- **[GitHub CLI](https://cli.github.com/)** (`gh`) +- [Node.js](https://nodejs.org/) (Versions 20–24) and [npm](https://www.npmjs.com/) +- [Corepack](https://nodejs.org/api/corepack.html), which is included with Node.js. After installing npm, enable via `corepack enable` +- [GitHub CLI](https://cli.github.com/) ## Installation From 22dc0b717be03352e58fcbb2a1db6bc18dbd13f0 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Wed, 13 May 2026 10:31:45 -0400 Subject: [PATCH 08/13] Update packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> --- .../patternfly-docs/content/AI/patternfly-cli.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index 31507e38cc..9bdff75f89 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -51,7 +51,18 @@ After installation, you can verify the latest version of the CLI has been instal ```sh patternfly-cli --version ``` +### Typical workflow +If you're starting a new project and publishing it, this is the usual sequence: + +[CODE FORMAT THIS] +patternfly-cli create my-app # create a new project from a template +cd my-app +patternfly-cli init # set up Git and connect to GitHub +patternfly-cli save # commit and push your changes +patternfly-cli deploy # publish to GitHub Pages + +For an existing project, use patternfly-cli update to migrate to a newer PatternFly version. ### Available CLI commands Once the PatternFly CLI is installed, you can run the following commands via `patternfly-cli [command]`: From 019cc419ca1d6cbdca4aaa05069084c1cc36d862 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Wed, 13 May 2026 10:32:05 -0400 Subject: [PATCH 09/13] Update packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> --- .../patternfly-docs/content/AI/patternfly-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index 9bdff75f89..f29a0bd63c 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -6,7 +6,7 @@ section: AI The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-line tool for scaffolding projects, performing code modifications, and running project-related tasks. It streamlines everyday development work and PatternFly upgrades, making it convenient and easy to work straight from the terminal. You can run it in the terminal on its own, or use it from an AI-enabled editor (such as [Cursor](https://www.cursor.com/)) so coding agents can rely on the same predictable commands for scaffolding, updates, and git workflows. The published package is [`@patternfly/patternfly-cli` on npm](https://www.npmjs.com/package/@patternfly/patternfly-cli). -The npm package installs two equivalent entry points: `patternfly-cli` and the shorter alias `pfcli`. The examples below use `patternfly-cli`; substitute `pfcli` if you prefer. +The npm package installs two equivalent entry points: `patternfly-cli` and the shorter alias `pfcli`. The examples below use `patternfly-cli`, but you can substitute `pfcli` in your own usage if you prefer. ## What does the PatternFly CLI help with? From 7ce886598a876372564f23a18e433cc01f672fe9 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Wed, 13 May 2026 10:32:19 -0400 Subject: [PATCH 10/13] Update packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> --- .../patternfly-docs/content/AI/patternfly-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index f29a0bd63c..b319b9e3b7 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -81,7 +81,7 @@ For the most up-to-date flags and behavior guidance, refer to [PatternFly CLI RE ### Predefined templates -Built-in templates ship with the CLI. Each row is the template `name` you pass to `patternfly-cli create` (or choose from the interactive prompt). To print the list from your installed version, run `patternfly-cli list`. +The following predefined templates ship with PatternFly CLI: | Template name | Description | | --- | --- | From 1310e4b6a064a87e8adb3e082f6bccdb8af77b2a Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Wed, 13 May 2026 10:32:31 -0400 Subject: [PATCH 11/13] Update packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> --- .../patternfly-docs/content/AI/patternfly-cli.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index b319b9e3b7..c3c09092e9 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -89,7 +89,9 @@ The following predefined templates ship with PatternFly CLI: | `compass-starter` | Starter template for a PatternFly Compass theme TypeScript project | | `nextjs-starter` | Starter template for a PatternFly Next.js project | -Template definitions in source: [patternfly-cli `src/templates.ts`](https://github.com/patternfly/patternfly-cli/blob/main/src/templates.ts). +To use a template, pass the template name to `patternfly-cli create [template name]` or choose the template from the interactive prompt triggered by the generic `patternfly-cli create` comman. To print a list of all templates from your installed version, run `patternfly-cli list`. + +Template definitions can be found in the [patternfly-cli repo](https://github.com/patternfly/patternfly-cli/blob/main/src/templates.ts). ### Custom templates From fca5d68f0698465bcc35cbfd9e3ad8edf8c17201 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Wed, 13 May 2026 10:32:46 -0400 Subject: [PATCH 12/13] Update packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> --- .../patternfly-docs/content/AI/patternfly-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index c3c09092e9..3943b44044 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -95,7 +95,7 @@ Template definitions can be found in the [patternfly-cli repo](https://github.co ### Custom templates -In addition to the built-in templates, you can add your own templates 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 template, the custom definition is used. +In addition to the predefined templates, you can add your own templates by passing a JSON file with `--template-file` (or `-t`). Custom templates are merged with the predefined list—if a custom template has the same `name` as a predefined template, the custom definition is used. **Create a project based on custom templates:** From 4e0975d4e612eaf4ac934d2e188bf1058efc8753 Mon Sep 17 00:00:00 2001 From: Donald Labaj Date: Wed, 13 May 2026 15:01:44 -0400 Subject: [PATCH 13/13] chore: fixed code format --- .../patternfly-docs/content/AI/patternfly-cli.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md index 3943b44044..e87d393532 100644 --- a/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md +++ b/packages/documentation-site/patternfly-docs/content/AI/patternfly-cli.md @@ -55,12 +55,13 @@ patternfly-cli --version If you're starting a new project and publishing it, this is the usual sequence: -[CODE FORMAT THIS] +```sh patternfly-cli create my-app # create a new project from a template cd my-app patternfly-cli init # set up Git and connect to GitHub patternfly-cli save # commit and push your changes patternfly-cli deploy # publish to GitHub Pages +``` For an existing project, use patternfly-cli update to migrate to a newer PatternFly version. ### Available CLI commands