Open
Conversation
Deploying patternfly-org with
|
| Latest commit: |
494d350
|
| Status: | 🚫 Build failed. |
Collaborator
edonehoo
requested changes
Mar 31, 2026
Collaborator
edonehoo
left a comment
edonehoo
left a comment
There was a problem hiding this comment.
some moving around and tweaking, lmk what you think!
| --- | ||
| id: PatternFly CLI | ||
| title: PatternFly CLI | ||
| section: get-started |
Collaborator
There was a problem hiding this comment.
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)?
| 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). |
Collaborator
There was a problem hiding this comment.
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
Comment on lines
+12
to
+16
| ## 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. |
Collaborator
There was a problem hiding this comment.
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
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you install the CLI, set up: |
Collaborator
There was a problem hiding this comment.
Suggested change
| Before you install the CLI, set up: | |
| Before you install the PatternFly CLI, you must set up the following: |
Comment on lines
+22
to
+24
| 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. |
Collaborator
There was a problem hiding this comment.
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?
| | `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. |
Collaborator
There was a problem hiding this comment.
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. |
|
|
||
| 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 |
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Custom templates | |
| ### Custom templates |
| 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. |
Collaborator
There was a problem hiding this comment.
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. |
|
|
||
| ## Custom templates | ||
|
|
||
| You can merge your own templates with the built-ins by passing a JSON file with `--template-file` (or `-t`): |
Collaborator
There was a problem hiding this comment.
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`): |
Comment on lines
+98
to
+100
| ## 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. |
Collaborator
There was a problem hiding this comment.
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?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a page discussing patternfly cli.