Skip to content

Latest commit

 

History

History
217 lines (216 loc) · 5.75 KB

examples.md

File metadata and controls

217 lines (216 loc) · 5.75 KB

Video using these commands: https://www.youtube.com/watch?v=Woo-mjKKe7k These commands work after installing the hax cli globally

npm install --global @haxtheweb/create

commands

Interactive program to step through options

hax start

Create a new web component or interact with an existing one

hax webcomponent

Create a new site or interact with an existing one

hax site

Audit HAX Web components

hax audit

Print Help information for options and arguments

hax help

webcomponent - new

Create a new webcomponent, prompt for details

hax webcomponent

Create a new webcomponent called x-button, accept defaults and launch

hax webcomponent x-button --y

webcomponent - existing

  • you already made a webcomponent called x-button, you want to work on it again
cd x-button
npm start

or

cd x-button
hax webcomponent

site - new

Create a new site, prompt for details

hax site

Create a new site called zombocom, prompt for theme and opening

hax site zombocom

Create a new site called zombocom, set theme to polaris-flex-theme and open the site to start working

hax site zombocom --theme "polaris-flex-theme" --y

Create a new site called zombocom, that has a custom theme called custom-zombocom-theme using the base template to get started

hax site zombocom --theme "custom-theme" --custom-theme-name "custom-zombocom-theme" --custom-theme-template "base" --y

site - existing site

--root ./zombocom - implies to run the command as if it was executed from the ./zombocom folder

site node operations

node:add

Add a page, setting root so that the call can be executed from a different directory than where the site lives

hax site --root ./zombocom node:add --title "My summer vacation" --content "<p>This is an awesome blog post I am writing about my vacation.</p>" --y

node:stats

Show data or content of a node, interactively

hax site node:stats

node:edit

Edit a detail about a node, interactively

hax site node:edit

Edit the title of a specific node, scripted.

hax site node:edit --item-id item-ac247e47-5dcf-4a98-814a-03f2e70151c8 --node-op title --title "my new title"

Edit the content of a specific node, scripted

hax site node:edit --item-id item-ac247e47-5dcf-4a98-814a-03f2e70151c8 --node-op content --content "<p>This is the new content</p><stop-note></stop-note>"

Edit the parent of a specific node, interactive selection

hax site node:edit --item-id item-ac247e47-5dcf-4a98-814a-03f2e70151c8 --node-op parent

node:delete

Delete a node, interactively

hax site node:delete

Delete a specific node, skip confirmation

hax site node:delete --item-id item-ac247e47-5dcf-4a98-814a-03f2e70151c8 --y

site operations

List stats for the current site

hax site site:stats

List items (nodes) for the current site and write them to a file called export-items.json

hax site site:items --to-file export-items.json

Import items (nodes) for the current site from a file called export-items.json

hax site site:items-import --items-import export-items.json

List files uploaded to the site

hax site site:list-files

Change theme, interactively

hax site site:theme

Change theme to clean-two, scripted

hax site site:theme --theme "clean-two" --y

Output the entire site as HTML with <h1> for title, redirected to file output.html

hax site site:html --to-file output.html

Output the entire site as MD with # for title, redirected to file output.md

hax site site:md --to-file output.md

Output the entire site as HAXSchema (vdom) with h1 for title, redirected to file schema.json

hax site site:schema --to-file schema.json

Sync git repo for the site, if hooked up to a remote

hax site site:sync

Publish site to surge.sh, interactively

hax site site:surge

Publish site to surge.sh, setting the domain to be my-cool-blog.surge.sh

hax site site:surge --domain my-cool-blog.surge.sh

Publish site to Netlify, interactively

hax site site:netlify

Publish site to Netlify, automated deployment

hax site site:netlify --y

Publish site to Netlify, setting the site ID to deploy to an existing site

hax site site:netlify --domain my-site-id --y

Publish site to Vercel, interactively

hax site site:vercel

Publish site to Vercel, automated deployment

hax site site:vercel --y

Publish site to Vercel, setting the project name

hax site site:vercel --domain my-project-name --y

Setup GitHub Actions deployment workflow (deploys automatically on git push)

hax site setup:github-actions

Setup GitHub Actions deployment workflow, overwrite existing file

hax site setup:github-actions --y

Setup GitLab CI deployment pipeline (deploys automatically on git push)

hax site setup:gitlab-ci

Setup GitLab CI deployment pipeline, overwrite existing file

hax site setup:gitlab-ci --y

Print out the recipe used in building the current site

hax site recipe:read

Play a site recipe against the current site, interactively

hax site recipe:play

Play a site recipe against the current site named create-cli.recipe, interactive selection per command

hax site recipe:play --recipe create-cli.recipe

Play a site recipe against the current site named create-cli.recipe, scripted

hax site recipe:play --recipe create-cli.recipe --y

audit

Audit HAX web component

hax audit

Audit HAX component while also printing all gathered .dddignore contents to console (for testing purposes)

hax --debug audit