feat: Added documenation for patternfly cli. by dlabaj · Pull Request #4981 · patternfly/patternfly-org

dlabaj · 2026-03-31T01:59:38Z

Added a page discussing patternfly cli.

Resolves issue # patternfly/patternfly-cli#18

cloudflare-workers-and-pages · 2026-03-31T02:00:56Z

Deploying patternfly-org with Cloudflare Pages

Latest commit:	`139bbe5`
Status:	🚫 Build failed.

View logs

patternfly-build · 2026-03-31T02:04:37Z

Preview: https://pf-org--pr-4981-site.surge.sh

edonehoo

some moving around and tweaking, lmk what you think!

edonehoo · 2026-03-31T17:55:07Z

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

+---
+id: PatternFly CLI
+title: PatternFly CLI
+section: get-started


the get started section is more so intended for introductory/overview information. Are you set on including these docs there? Otherwise, we could move to /developer-guides or maybe at least nest it under get-started/develop (assuming this is a dev-focused tool)?

This is for both designers and developers. At the moment it's geared towards designers more. I'm good with putting it under developer guides

edonehoo · 2026-03-31T17:56:05Z

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

+import './get-started.css';
+import { Alert } from '@patternfly/react-core';
+
+The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-line tool for scaffolding projects, applying code changes, and running common project tasks. It is published as [`@patternfly/patternfly-cli` on npm](https://www.npmjs.com/package/@patternfly/patternfly-cli).


Suggested change

The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-line tool for scaffolding projects, applying code changes, and running common project tasks. It is published as [`@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 published on npm as [`@patternfly/patternfly-cli`](https://www.npmjs.com/package/@patternfly/patternfly-cli). With this tool, you can scaffold projects from built-in or custom templates, automate code updates for repetitive changes, and run workflows (including init, sync with GitHub, updates, and deploys to GitHub Pages).

The PatternFly CLI is developed in the open at [github.com/patternfly/patternfly-cli](https://github.com/patternfly/patternfly-cli), with release notes and tags published on [Releases page](https://github.com/patternfly/patternfly-cli/releases). To report issues or contribute to this tool, refer to the patternfly-cli repo for more instruction.

wdyt about this description, rather than the "what you can do" list? Just to build those list points into the narrative a little more

also moved up the bit about source and releases from the end of the page

edonehoo · 2026-03-31T17:59:47Z

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

+## What you can do
+
+- **Scaffold projects** from built-in or custom templates.
+- **Automate code updates** for repetitive changes.
+- **Run workflows** such as init, sync with GitHub, updates, and deploys to GitHub Pages.


Suggested change

## What you can do

- **Scaffold projects** from built-in or custom templates.

- **Automate code updates** for repetitive changes.

- **Run workflows** such as init, sync with GitHub, updates, and deploys to GitHub Pages.

remove, if you're okay with folding into the intro description as I did

edonehoo · 2026-03-31T18:00:40Z

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

+
+## Prerequisites
+
+Before you install the CLI, set up:


Suggested change

Before you install the CLI, set up:

Before you install the PatternFly CLI, you must set up the following:

edonehoo · 2026-03-31T18:04:11Z

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

+1. **[Node.js and npm](https://nodejs.org/)** (supported versions **20–24**).
+1. **[Corepack](https://nodejs.org/api/corepack.html)** — included with Node.js; enable it with `corepack enable` after installing Node.
+1. **[GitHub CLI](https://cli.github.com/)** (`gh`) — required for commands that talk to GitHub.


Suggested change

1. **[Node.js and npm](https://nodejs.org/)** (supported versions **20–24**).

1. **[Corepack](https://nodejs.org/api/corepack.html)** — included with Node.js; enable it with `corepack enable` after installing Node.

1. **[GitHub CLI](https://cli.github.com/)** (`gh`) — required for commands that talk to GitHub.

1. **[Node.js and npm](https://nodejs.org/)** (versions 20–24 currently supported).

1. **[Corepack](https://nodejs.org/api/corepack.html):** After Node is installed, enabled corepack via `corepack enable` on the command line.

1. **[GitHub CLI](https://cli.github.com/):** Required for commands that refer to GitHub (`gh`).

Is corepack enable a cli command?

edonehoo · 2026-03-31T18:11:37Z

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

+| `load` | Pull the latest changes from GitHub. |
+| `deploy` | Build and deploy the app to GitHub Pages. |
+
+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.


Suggested change

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.

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

edonehoo · 2026-03-31T18:11:46Z

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

+
+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.
+
+## Custom templates


Suggested change

## Custom templates

### Custom templates

edonehoo · 2026-03-31T18:13:24Z

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

+patternfly-cli list --template-file ./my-templates.json
+```
+
+Each entry is an object with at least `name`, `description`, and `repo` (clone URL). Optional fields include `options` (extra `git clone` arguments) and `packageManager` (`npm`, `yarn`, or `pnpm`; default is `npm`). If a custom template uses the same `name` as a built-in one, the custom definition wins.


Suggested change

Each entry is an object with at least `name`, `description`, and `repo` (clone URL). Optional fields include `options` (extra `git clone` arguments) and `packageManager` (`npm`, `yarn`, or `pnpm`; default is `npm`). If a custom template uses the same `name` as a built-in one, the custom definition wins.

Each entry is an object with at least `name`, `description`, and `repo` (clone URL). Optional fields include `options` (extra `git clone` arguments) and `packageManager` (`npm` by default, or `yarn`/`pnpm`). If a custom template uses the same `name` as a built-in template, the custom definition is used.

edonehoo · 2026-03-31T18:13:37Z

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

+
+## Custom templates
+
+You can merge your own templates with the built-ins by passing a JSON file with `--template-file` (or `-t`):


Suggested change

You can merge your own templates with the built-ins by passing a JSON file with `--template-file` (or `-t`):

You can merge your own templates with the built-in templates by passing a JSON file with `--template-file` (or `-t`):

edonehoo · 2026-03-31T18:14:08Z

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

+## Source and releases
+
+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.


Suggested change

## Source and releases

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.

moving up top?

Do we even need this? I can remove it since the guidance link will take you to the readme that will have this information in it. Removing for now, if you want me to add it back let me know.

dlabaj

@edonehoo Had some feed back during usability testing. Can you take another look. Also left some responses to review comments since the structure of the doc changed some.

dlabaj · 2026-04-03T00:05:14Z

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

+patternfly-cli [command]
+```
+
+| Command | Description |


packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md

dlabaj · 2026-04-03T00:06:35Z

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

+- **Automate code updates** for repetitive changes.
+- **Run workflows** such as init, sync with GitHub, updates, and deploys to GitHub Pages.
+
+## Prerequisites


dlabaj · 2026-04-03T00:12:25Z

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

+## Source and releases
+
+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.


Do we even need this? I can remove it since the guidance link will take you to the readme that will have this information in it. Removing for now, if you want me to add it back let me know.

dlabaj · 2026-04-03T00:24:13Z

@edonehoo Latest updates can be found here: http://pf-cli.surge.sh/developer-guides/patternfly-cli

edonehoo

some more thoughts and suggestions - lmk what you think!

edonehoo · 2026-04-03T17:43:25Z

packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md

+---
+id: PatternFly CLI
+title: PatternFly CLI
+section: developer-guides


Suggested change

section: developer-guides

section: get-started

just saw your previous reply that this tool is actually more oriented towards designers right now. with that in mind (combined with the technicality of the doc itself), I think your initial suggestion of putting this in the get started section is okay for now actually

edonehoo · 2026-04-03T17:46:25Z

packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md

+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).


I did just want to mention that (as someone who has no knowledge of this tool) it's not extremely clear to me why this is a separate tool and why designers will be using this. When I read "streamline development workflows and improve productivity" it just sounds like a general dev accelerator tool, so it might be helpful to more explicitly state why we've created this new tool, why we're doing it now, and what's special about it. If I was a designer I wouldn't necessarily pick up that this tool was intended for me to use

that extra context could go up front or in the next ## Features section

packages/documentation-site/patternfly-docs/content/developer-guides/patternfly-cli.md

…guides/patternfly-cli.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>

feat: Added documenation for patternfly cli.

494d350

dlabaj requested a review from edonehoo March 31, 2026 01:59

edonehoo requested changes Mar 31, 2026

View reviewed changes

dlabaj linked an issue Apr 2, 2026 that may be closed by this pull request

Alpha release usability testing. patternfly/patternfly-cli#18

Open

4 tasks

dlabaj added 3 commits April 2, 2026 19:45

chore: Update with comments from usability testing.

311103c

chore: Added review comments.

47ec8f3

chore: Added review comments.

2af1111

dlabaj commented Apr 3, 2026

View reviewed changes

dlabaj added 2 commits April 2, 2026 20:16

chore: Added review comments.

7128c86

chore: Added review comments.

dfdd52f

edonehoo reviewed Apr 3, 2026

View reviewed changes

dlabaj and others added 2 commits April 6, 2026 13:15

Update packages/documentation-site/patternfly-docs/content/developer-…

d526d7f

…guides/patternfly-cli.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>

Apply suggestions from code review

139bbe5

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>

-The [PatternFly CLI](https://github.com/patternfly/patternfly-cli) is a command-line tool for scaffolding projects, applying code changes, and running common project tasks. It is published as [`@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 published on npm as [`@patternfly/patternfly-cli`](https://www.npmjs.com/package/@patternfly/patternfly-cli). With this tool, you can scaffold projects from built-in or custom templates, automate code updates for repetitive changes, and run workflows (including init, sync with GitHub, updates, and deploys to GitHub Pages).
+The PatternFly CLI is developed in the open at [github.com/patternfly/patternfly-cli](https://github.com/patternfly/patternfly-cli), with release notes and tags published on [Releases page](https://github.com/patternfly/patternfly-cli/releases). To report issues or contribute to this tool, refer to the patternfly-cli repo for more instruction.

	Before you install the CLI, set up:
	Before you install the PatternFly CLI, you must set up the following:

	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.
	For the most up-to-date flags and behavior guidance, refer to the [PatternFly CLI README](https://github.com/patternfly/patternfly-cli/blob/main/README.md) on GitHub.


		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.

		## Custom templates

	Each entry is an object with at least `name`, `description`, and `repo` (clone URL). Optional fields include `options` (extra `git clone` arguments) and `packageManager` (`npm`, `yarn`, or `pnpm`; default is `npm`). If a custom template uses the same `name` as a built-in one, the custom definition wins.
	Each entry is an object with at least `name`, `description`, and `repo` (clone URL). Optional fields include `options` (extra `git clone` arguments) and `packageManager` (`npm` by default, or `yarn`/`pnpm`). If a custom template uses the same `name` as a built-in template, the custom definition is used.


		## Custom templates

		You can merge your own templates with the built-ins by passing a JSON file with `--template-file` (or `-t`):

		## Source and releases

		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.

Conversation

dlabaj commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying patternfly-org with Cloudflare Pages

Uh oh!

patternfly-build commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

edonehoo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dlabaj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dlabaj commented Apr 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

edonehoo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dlabaj commented Mar 31, 2026 •

edited

Loading

cloudflare-workers-and-pages bot commented Mar 31, 2026 •

edited

Loading

patternfly-build commented Mar 31, 2026 •

edited

Loading

dlabaj commented Apr 3, 2026 •

edited

Loading