Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ hax start
- if in a monorepo root, will place in correct location / inherit settings
- `hax site mysite --y` - create a new HAXsite (HAXcms, single site)
- `hax audit` - Audits web components for compliance with DDD (HAX design system)
- `hax update` - HAX CLI self update
- `hax party` - Display options to join the HAX community and get involved!

## --help
Run `hax help` or `hax webcomponent --help` or `hax site --help` for up-to-date listing
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"release": "npm run build && commit-and-tag-version && git push --follow-tags origin main && npm publish",
"hax": "hax",
"dev": "nodemon --watch src",
"haxcms-nodejs": "haxcms-nodejs"
"haxcms-nodejs": "haxcms-nodejs",
"local": "npm run build && npm link"
},
"man": [
"./dist/docs/hax.1"
Expand Down
39 changes: 33 additions & 6 deletions src/docs/hax.1
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,24 @@ This command line tool can be used to create and modify two different HAX based
.B start
\- Interactive program to pick options
.PP
.B update
[options] \- HAX CLI self update
.PP
.B serve
\- Launch HAXsite in development mode (http://localhost)
.PP
.B site
[options] [action] \- Create a HAX website
[options] [action] \- Create or administer a HAX website
.PP
.B webcomponent
[options] [name] \- Create Lit based web components, with HAX recommendations
.B wc | webcomponent
[options] [action] \- Create Lit based web components, with HAX recommendations
.PP
.B audit
[options] \- Audits web components for compliance with DDD (HAX design system)
.PP
.B party
[options] [action] \- Party time! Join the HAX community and get involved!
.PP
.B help
[command] \- Display help for command

Expand All @@ -42,6 +51,9 @@ Output format\; json (default), yaml
\--path [path]
Where to perform operation
.TP
\--name [name]
Name of the project / web component
.TP
\--npm\-client [client]
NPM client to use (must be installed); npm (default), yarn, pnpm
.TP
Expand Down Expand Up @@ -87,9 +99,6 @@ Node operation to perform
\--item\-id [id]
Node ID to operate on
.TP
\--name [name]
Name of the project
.TP
\--domain [name]
Published domain name
.TP
Expand All @@ -111,6 +120,24 @@ Custom theme name
\--custom\-theme\-template [option]
Custom theme template (Options: base | polaris-flex | polaris-sidebar)
.TP
\--source [char]
rsync source directory or remote path
.TP
\--destination [char]
rsync destination directory or remote path
.TP
\--exclude [char]
comma-separated patterns to exclude from rsync
.TP
\--dry-run
perform rsync dry run
.TP
\--delete
delete extraneous files from destination
.TP
\--repos [char...]
repositories to clone
.TP
\-V, \--version
Output the version number
.TP
Expand Down
Loading