# @unistylus/cli

> Tools for the Unistylus framework.

Latest version **0.0.12** (published 2021-10-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @unistylus/cli
pnpm add @unistylus/cli
yarn add @unistylus/cli
bun add @unistylus/cli
```

Provides the command `unistylus`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.12 |
| Published | 2021-10-21 |
| First published | 2021-06-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 231 KB |
| Known vulnerabilities | 0 (+32 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lam Nhan |
| Maintainers | lamnhan |
| Keywords | node, module, cli |

## Links

- npm: https://www.npmjs.com/package/@unistylus/cli
- Repository: https://github.com/unistylus/cli
- Homepage: https://unistylus.lamnhan.com
- Issues: https://github.com/unistylus/cli/issues
- npm.io page: https://npm.io/package/@unistylus/cli

## Dependencies (17)

- [del](https://npm.io/package/del.md) ^6.0.0
- [sass](https://npm.io/package/sass.md) ^1.42.1
- [axios](https://npm.io/package/axios.md) ^0.21.4
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [marked](https://npm.io/package/marked.md) ^3.0.7
- [rollup](https://npm.io/package/rollup.md) ^2.58.0
- [terser](https://npm.io/package/terser.md) ^5.9.0
- [adm-zip](https://npm.io/package/adm-zip.md) ^0.4.16
- [prismjs](https://npm.io/package/prismjs.md) ^1.25.0
- [chokidar](https://npm.io/package/chokidar.md) ^3.5.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [commander](https://npm.io/package/commander.md) ^6.1.0
- [tty-table](https://npm.io/package/tty-table.md) ^4.1.3
- [typescript](https://npm.io/package/typescript.md) ^4.0.3
- [change-case](https://npm.io/package/change-case.md) ^4.1.2
- [live-server](https://npm.io/package/live-server.md) ^1.2.1
- [recursive-readdir](https://npm.io/package/recursive-readdir.md) ^2.2.2

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.12 (latest) — 2021-10-21
- 0.0.11 — 2021-10-20
- 0.0.10 — 2021-10-19
- 0.0.9 — 2021-10-19
- 0.0.8 — 2021-10-17
- 0.0.7 — 2021-10-16
- 0.0.6 — 2021-10-16
- 0.0.5 — 2021-10-13
- 0.0.4 — 2021-10-12
- 0.0.3 — 2021-10-10
- 0.0.2 — 2021-10-10
- 0.0.1 — 2021-06-13

## README

<section id="head" data-note="AUTO-GENERATED CONTENT, DO NOT EDIT DIRECTLY!">

# @unistylus/cli

**Tools for the Unistylus framework.**

</section>

<section id="tocx" data-note="AUTO-GENERATED CONTENT, DO NOT EDIT DIRECTLY!">

- [Getting started](#getting-started)
- [Command overview](#cli-command-overview)
- [Command reference](#cli-command-reference)
  - [`add`](#command-add)
  - [`build`](#command-build)
  - [`clean`](#command-clean)
  - [`copy`](#command-copy)
  - [`generate`](#command-generate)
  - [`install`](#command-install)
  - [`js`](#command-js)
  - [`new`](#command-new)
  - [`remove`](#command-remove)
  - [`serve`](#command-serve)
  - [`uninstall`](#command-uninstall)
  - [`use`](#command-use)
  - [`help`](#command-help)
  - [`*`](#command-*)
- [Detail API reference](https://unistylus-cli.lamnhan.com)


</section>

<section id="getting-stated">

## Getting started

- Install & init

```sh
npx @unistylus/cli new
```

- Install globally:

```sh
npm install -g @unistylus/cli
```

Create a project:

```sh
unistylus new
```

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

Generate distribution:

```sh
unistylus generate
```

Next, see the homepage: [https://unistylus.lamnhan.com](https://unistylus.lamnhan.com)

</section>

<section id="cli" data-note="AUTO-GENERATED CONTENT, DO NOT EDIT DIRECTLY!">

<h2><a name="cli-command-overview"><p>Command overview</p>
</a></h2>

Tools for the Unistylus framework.

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

<h2><a name="cli-command-reference"><p>Command reference</p>
</a></h2>

<h3><a name="command-add"><p><code>add</code></p>
</a></h3>

Add a skin or a part.

**Usage:**

```sh
unistylus add <name>
unistylus a <name>
```

**Parameters:**

- `<name>`: Name of the skin or part

<h3><a name="command-build"><p><code>build</code></p>
</a></h3>

Build web.

**Usage:**

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

**Options:**

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

<h3><a name="command-clean"><p><code>clean</code></p>
</a></h3>

Clean a folder.

**Usage:**

```sh
unistylus clean <path>
unistylus del <path>
unistylus d <path>
```

**Parameters:**

- `<path>`: The `<path>` parameter.

<h3><a name="command-copy"><p><code>copy</code></p>
</a></h3>

Copy resources

**Usage:**

```sh
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.

<h3><a name="command-generate"><p><code>generate</code></p>
</a></h3>

Generate content.

**Usage:**

```sh
unistylus generate
unistylus g
```

<h3><a name="command-install"><p><code>install</code></p>
</a></h3>

Install a collection.

**Usage:**

```sh
unistylus install <name>
unistylus i <name>
```

**Parameters:**

- `<name>`: Name of the collection to be added

<h3><a name="command-js"><p><code>js</code></p>
</a></h3>

Build js package.

**Usage:**

```sh
unistylus js
```

<h3><a name="command-new"><p><code>new</code></p>
</a></h3>

Create a new collection.

**Usage:**

```sh
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.

<h3><a name="command-remove"><p><code>remove</code></p>
</a></h3>

Remove a skin or a part.

**Usage:**

```sh
unistylus remove <name>
unistylus r <name>
```

**Parameters:**

- `<name>`: Name of the skin or part

<h3><a name="command-serve"><p><code>serve</code></p>
</a></h3>

Serve the collection for development.

**Usage:**

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

**Options:**

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

<h3><a name="command-uninstall"><p><code>uninstall</code></p>
</a></h3>

Install a collection.

**Usage:**

```sh
unistylus uninstall <name>
unistylus un <name>
```

**Parameters:**

- `<name>`: Name of the collection to be removed

<h3><a name="command-use"><p><code>use</code></p>
</a></h3>

Use a collection.

**Usage:**

```sh
unistylus use <name>
unistylus u <name>
```

**Parameters:**

- `<name>`: Name of the collection to changed to

<h3><a name="command-help"><p><code>help</code></p>
</a></h3>

Display help.

**Usage:**

```sh
unistylus help
```

<h3><a name="command-*"><p><code>*</code></p>
</a></h3>

Any other command is not suppoted.

**Usage:**

```sh
unistylus <cmd>
```

</section>

<section id="license" data-note="AUTO-GENERATED CONTENT, DO NOT EDIT DIRECTLY!">

## License

**@unistylus/cli** is released under the [MIT](https://github.com/unistylus/cli/blob/master/LICENSE) license.

</section>

---
_Source: https://npm.io/package/@unistylus/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._