https://github.com/patternfly/pfe-tools
https://github.com/patternfly/pfe-tools
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/patternfly/pfe-tools
- Owner: patternfly
- Created: 2021-09-01T11:31:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-01T11:34:14.000Z (over 4 years ago)
- Last Synced: 2024-12-18T23:17:09.561Z (about 1 year ago)
- Language: TypeScript
- Size: 96.7 KB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
@patternfly/pfe-tools
=====================
[](https://oclif.io)
[](https://npmjs.org/package/@patternfly/pfe-tools)
[](https://npmjs.org/package/@patternfly/pfe-tools)
[](https://github.com/kylebuch8/pfe-tools/blob/master/package.json)
This is a WIP repository for extracting the dev tools out of the PatternFly Elements project.
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g @patternfly/pfe-tools
$ pfe-tools COMMAND
running command...
$ pfe-tools (-v|--version|version)
@patternfly/pfe-tools/0.0.0 darwin-x64 node-v14.15.4
$ pfe-tools --help [COMMAND]
USAGE
$ pfe-tools COMMAND
...
```
# Commands
* [`pfe-tools build [FILE]`](#pfe-tools-build-file)
* [`pfe-tools dev [FILE]`](#pfe-tools-dev-file)
* [`pfe-tools hello [FILE]`](#pfe-tools-hello-file)
* [`pfe-tools help [COMMAND]`](#pfe-tools-help-command)
* [`pfe-tools new`](#pfe-tools-new)
* [`pfe-tools test-watch [FILE]`](#pfe-tools-test-watch-file)
## `pfe-tools build [FILE]`
Build all of the elements
```
USAGE
$ pfe-tools build [FILE]
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
```
_See code: [src/commands/build.ts](https://github.com/kylebuch8/pfe-tools/blob/v0.0.0/src/commands/build.ts)_
## `pfe-tools dev [FILE]`
Dev runs the build script with a watcher
```
USAGE
$ pfe-tools dev [FILE]
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
```
_See code: [src/commands/dev.ts](https://github.com/kylebuch8/pfe-tools/blob/v0.0.0/src/commands/dev.ts)_
## `pfe-tools hello [FILE]`
describe the command here
```
USAGE
$ pfe-tools hello [FILE]
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
EXAMPLE
$ pfe-tools hello
hello world from ./src/hello.ts!
```
_See code: [src/commands/hello.ts](https://github.com/kylebuch8/pfe-tools/blob/v0.0.0/src/commands/hello.ts)_
## `pfe-tools help [COMMAND]`
display help for pfe-tools
```
USAGE
$ pfe-tools help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.3/src/commands/help.ts)_
## `pfe-tools new`
Create a new web component
```
USAGE
$ pfe-tools new
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
```
_See code: [src/commands/new.ts](https://github.com/kylebuch8/pfe-tools/blob/v0.0.0/src/commands/new.ts)_
## `pfe-tools test-watch [FILE]`
describe the command here
```
USAGE
$ pfe-tools test-watch [FILE]
OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print
```
_See code: [src/commands/test-watch.ts](https://github.com/kylebuch8/pfe-tools/blob/v0.0.0/src/commands/test-watch.ts)_