@unistylus/cli

@unistylus/cli

Tools for the Unistylus framework.

• Getting started
• Command overview
• Command reference
  • add
  • build
  • clean
  • copy
  • generate
  • install
  • js
  • new
  • remove
  • serve
  • uninstall
  • use
  • help
  • *
• Detail API reference

Getting started

• Install & init

npx @unistylus/cli new

• Install globally:

npm install -g @unistylus/cli

Create a project:

unistylus new

Add your own collection src/, edit the .unistylusrc.json.

Generate distribution:

unistylus generate

Next, see the homepage: https://unistylus.lamnhan.com

Command overview

Tools for the Unistylus framework.

• unistylus add|a <name>
• unistylus build|b --out [value] --api
• unistylus clean|del|d <path>
• unistylus copy|c [items...] --src [value] --out [value] --clean
• unistylus generate|g
• unistylus install|i <name>
• unistylus js
• unistylus new|n <name> [description] --skip-install --skip-git
• unistylus remove|r <name>
• unistylus serve|s --out [value]
• unistylus uninstall|un <name>
• unistylus use|u <name>
• unistylus help
• unistylus *

Command reference

add

Add a skin or a part.

Usage:

unistylus add <name>
unistylus a <name>

Parameters:

• <name>: Name of the skin or part

build

Build web.

Usage:

unistylus build --out [value] --api
unistylus b --out [value] --api

Options:

• -o, --out [value]: Custom output folder.
• -a, --api: Output the API.

clean

Clean a folder.

Usage:

unistylus clean <path>
unistylus del <path>
unistylus d <path>

Parameters:

• <path>: The <path> parameter.

copy

Copy resources

Usage:

unistylus copy [items...] --src [value] --out [value] --clean
unistylus c [items...] --src [value] --out [value] --clean

Parameters:

• [items...]: List of items

Options:

• -s, --src [value]: Source of items.
• -o, --out [value]: Copy destination.
• -c, --clean: Clean the output first.

generate

Generate content.

Usage:

unistylus generate
unistylus g

install

Install a collection.

Usage:

unistylus install <name>
unistylus i <name>

Parameters:

• <name>: Name of the collection to be added

js

Build js package.

Usage:

unistylus js

new

Create a new collection.

Usage:

unistylus new <name> [description] --skip-install --skip-git
unistylus n <name> [description] --skip-install --skip-git

Parameters:

• <name>: The collection name
• [description]: The description

Options:

• -i, --skip-install: Do not install dependency packages.
• -g, --skip-git: Do not initialize a git repository.

remove

Remove a skin or a part.

Usage:

unistylus remove <name>
unistylus r <name>

Parameters:

• <name>: Name of the skin or part

serve

Serve the collection for development.

Usage:

unistylus serve --out [value]
unistylus s --out [value]

Options:

• -o, --out [value]: Custom output folder.

uninstall

Install a collection.

Usage:

unistylus uninstall <name>
unistylus un <name>

Parameters:

• <name>: Name of the collection to be removed

use

Use a collection.

Usage:

unistylus use <name>
unistylus u <name>

Parameters:

• <name>: Name of the collection to changed to

help

Display help.

Usage:

unistylus help

*

Any other command is not suppoted.

Usage:

unistylus <cmd>

License

@unistylus/cli is released under the MIT license.