Command Line Interface (CLI)

The tikui command line helps you to generate component documentation. It's also useful to generate an entire Tikui Pattern Library.

Installation

First of all, you need to install @tikui/cli

npm i -g @tikui/cli

Now you'll be able to use tikui command.

help

Show you a help message with all the available commands.

Example:

tikui help 

You can also use help on a command, for example:

tikui help generate

Because @tikui/cli can change independently of the documentation, we encourage you to use the help command to have the most up-to-date information.

generate

Generate an entire Tikui Pattern Library.

Example:

tikui generate pl

Here directory pl will be generated as a Tikui Pattern Library.

You may need to launch:

cd pl
npm i

To install your Pattern Library.

create

Create a new documented component.

Example:

tikui create button src/atom

Here component and documentation files for button will be created under src/atom.

You're now able to link style using @use 'button/button' from a parent SCSS file.

You're also able to link documentation using include:componentDoc button/button.md from a parent pug file.

You can learn more about the component structure in the component documentation.