# @wizzi/cli

> Wizzi Command Line Interface

Latest version **0.8.11** (published 2025-01-21) · 0 weekly downloads

## Install

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

Provides the command `wz`.

## Health

**Score 20/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.11 |
| Published | 2025-01-21 |
| First published | 2023-06-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 19 |
| Unpacked size | 2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Stefano Bassoli |
| Maintainers | stfn.bssl |

## Links

- npm: https://www.npmjs.com/package/@wizzi/cli
- npm.io page: https://npm.io/package/@wizzi/cli

## Dependencies (19)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [memfs](https://npm.io/package/memfs.md) latest
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [commander](https://npm.io/package/commander.md) ^7.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.0.0
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.0.0
- [@wizzi/utils](https://npm.io/package/@wizzi/utils.md) 0.8.25
- [@wizzi/factory](https://npm.io/package/@wizzi/factory.md) 0.8.46
- [isomorphic-git](https://npm.io/package/isomorphic-git.md) latest
- [@wizzi/plugin.js](https://npm.io/package/@wizzi/plugin.js.md) 0.8.9
- [@wizzi/plugin.md](https://npm.io/package/@wizzi/plugin.md.md) 0.8.8
- [@wizzi/plugin.css](https://npm.io/package/@wizzi/plugin.css.md) 0.8.7
- [@wizzi/plugin.html](https://npm.io/package/@wizzi/plugin.html.md) 0.8.9
- [@wizzi/plugin.ittf](https://npm.io/package/@wizzi/plugin.ittf.md) 0.8.13
- [@wizzi/plugin.json](https://npm.io/package/@wizzi/plugin.json.md) 0.8.8
- [@wizzi/plugin.text](https://npm.io/package/@wizzi/plugin.text.md) 0.8.5
- [@wizzi/plugin.wzjob](https://npm.io/package/@wizzi/plugin.wzjob.md) 0.8.4
- [@wizzi/plugin.wzschema](https://npm.io/package/@wizzi/plugin.wzschema.md) 0.8.3

## Recent versions

- 0.8.11 (latest) — 2025-01-21
- 0.8.10 — 2024-08-31
- 0.8.9 — 2024-08-30
- 0.8.8 — 2024-08-30
- 0.8.7 — 2024-08-30
- 0.8.6 — 2024-05-06
- 0.8.5 — 2024-05-06
- 0.8.4 — 2024-04-25
- 0.8.3 — 2023-06-09
- 0.8.2 — 2023-06-09
- 0.8.1 — 2023-06-09

## README

# wizzi.cli

Wizzi Command Line Interface



## Work still in progress

Availability of features will be announced
on [Twitter](https://twitter.com/wizziteam) and [Facebook](https://www.facebook.com/wizzifactory)

```undefined
npm install -g wizzi-cli
```
# wizzi-cli
The Wizzi command line interface (CLI) performs basic functionality, such as executing a Wizzi Production, creating a Wizzi Package based on a templated Meta Production, wizzifying an existent artifact or a folder of artifacts, meta wizzifying an existent wizzi package
The Wizzi CLI is packaged as an executable that can be used globally. Is available via [npm](https://www.npmjs.com/) and should be installed globally by running
```undefined
npm install -g wizzi-cli
```
Run `wz help` for full help.
## CLI Commands
## "main"
*Execute a wizzi package production (default) or a single artifact or single folder production or a specified command*
```undefined
wz [noarguments | configname | --source <file|folder> --dest <file|folder> -ctx <file>[-ctx <file>]...] --config <file>| [command <options>]
```
|Argument                       |Description                                                                                                                                                                                                                         \||
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|noarguments                    |execute a wizzi production using the 'wizzi.config.js' default config file                                                                                                                                                           
|
|configname                     |execute a wizzi production using the 'wizzi.config.<configname>.js' config file                                                                                                                                                      
\|- The config file is searched in the current and upwards in parent folders|
|[--source \| -s] <file \| folder>|execute the wizzi production of a single file or folder using optionaly one or more context data files (json or yaml                                                                                                                 
|
|[--dest \| -d] <file \| folder>|the destination file or folder of the production. A source folder requires a destination folder.                                                                                                                                     
|
|[--config \| -c] <file>        |the path to the optional generation configuration file: <file>.config.js                                                                                                                                                             
\|- Basic plugins are included in the Wizzi CLI.\|- You can add extra plugins using a config file of the same format as for the 'wz' command.|

commands:
 job ................. execute a wizzi job
 fy .................. wizzify a file or folder
 meta ................ execute a wizzi meta production
 metify .............. execute the 'metafication' of a wizzi production
 version ............. show package version
 help ................ show help menu for a command
 |- Try: wz help [command] to see each command options
## "job"
*Execute the wizzi job defined in a configuration file*
```undefined
wz job --config <file>
```
|Argument                    |Description                                                                                                                                                                                                                         \||
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|[--config \| -c] <configname>|the name of the job configuration file: <configname>.config.js                                                                                                                                                                       
\|- The config file is searched in the current folder|

## "fy"
*Execute the 'wizzifycation' of a file or folder*
```undefined
wz fy --source <file|folder> --dest <file|folder> --config <file>
```
|Argument                       |Description                                                                                                                                                                                                                         \||
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|[--source \| -s] <file \| folder>|the source file or folder                                                                                                                                                                                                            
|
|[--dest \| -d] <file \| folder>|the destination file or folder                                                                                                                                                                                                       
|
|[--config \| -c] <file>        |a config file for extra plugins                                                                                                                                                                                                      
\|- A wizzi plugin can optionaly contain a wizzifier for its language schema.\|- Basic wizzifiers are included in the Wizzi CLI.\|- You can add extra plugins using a config file of the same format as for the 'wz' command.|

## "meta"
*Execute a wizzi meta production*
```undefined
wz meta [<metaname> | --config <filepath>
```
|Argument|Description                                                                                                                                                                                                                         \||
|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|metaname|the name of the meta production config file: wizzi.meta.config.<metaname>.js                                                                                                                                                         
\|- The config file is searched in the current (cwd) and upwards in parent folders|
|config  |the path of the meta production config file: <filepath>.config.js                                                                                                                                                                    
\|- The config file|

## "metify"
*Execute the 'metafication' of a wizzi folder*
```undefined
wz metify --source <folder> --dest <folder> [--name <name>] [--compress <subfolder[;subfolder[;...]]>>]
```
|Argument         |Description                                                                                                                                                                                                                         \||
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|[--source \| -s] |the source file or folder                                                                                                                                                                                                            
|
|[--dest \| -d]   |the destination file or folder                                                                                                                                                                                                       
|
|[--name \| -n]   |the name to assign to the created meta production                                                                                                                                                                                    
|
|[--compress \| -c]|semicolon separated list of folders that you prefer 'metamanaged' by their parents                                                                                                                                                   
|



## Wizzi

One machinery, many productions.


[Project page](https://stfnbssl.github.io/wizzi)
## Built With
* [Nodejs](https://nodejs.org)
* [Wizzi](https://github.com/stfnbssl/wizzi)

## License
This project is licensed under the MIT License - see the [license.txt](license.txt) for details.

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