@unified-ux/cli
CLI for developing, documenting and wrapping Unified UX components
Usage
$ npm install -g @unified-ux/cli
$ uux COMMAND
running command...
$ uux (-v|--version|version)
@unified-ux/cli/2.0.0 linux-x64 node-v12.18.4
$ uux --help [COMMAND]
USAGE
$ uux COMMAND
...
Commands
uux doc [INPUT]
uux generate [SCHEMATIC] [NAME]
uux help [COMMAND]
uux maestro [INPUT]
uux sass [INPUT]
uux doc [INPUT]
Generates web component documentation via mustache templates
USAGE
$ uux doc [INPUT]
OPTIONS
-d, --outDir=outDir Specify the output directory for the documentation, by default this will be the same as the
found component, the outFile will default to the component name
-h, --help show CLI help
-j, --json Outputs json instead of docs
-o, --outFile=outFile [default: README.md] Specify the output file for the documentation, by default this will be a
markdown file of README.md
-t, --template=template Specify the mustache template file for the documentation, if not provided a default template
will be used
EXAMPLES
$ uux doc ../packages/web/src
$ uux doc ../packages/web/src --template blueprint.mustache --outFile README.md
uux generate [SCHEMATIC] [NAME]
Generates and/or modifies files based on a schematic.
USAGE
$ uux generate [SCHEMATIC] [NAME]
OPTIONS
-f, --force Using force will override any folders and files that already exist.
-h, --help show CLI help
-p, --prefix=prefix The prefix to apply to the generated component selector.
--folderPath=folderPath For a new component, puts the generated files in the specified folder
--storyFolderPath=storyFolderPath For a new component, puts the generated story file only in specified folder
EXAMPLES
$ uux generate component my-text-field
$ uux generate library my-library
uux help [COMMAND]
display help for uux
USAGE
$ uux help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
uux maestro [INPUT]
Generate Unified UX components in a Maestro Component library
USAGE
$ uux maestro [INPUT]
OPTIONS
-h, --help show CLI help
-o, --output=output Output directory
-z, --zip=zip Archive as a Maestro Library Zip file
EXAMPLE
$ uux maestro "packages/web/src/**/*.ts" --output "packages/maestro/src" --zip dist
uux sass [INPUT]
Render sass into a template, used for importable style modules in components
USAGE
$ uux sass [INPUT]
OPTIONS
-h, --help show CLI help
-s, --suffix=suffix [default: -css.ts] Output file suffix, default is "css.ts"
-t, --template=template Template file to use, must use `<% content %>` as delimiter
EXAMPLE
$ uux sass "packages/web/src/!(theme)/*.scss" --template sass-template.js --suffix css.ts