| 1 | # What's Zignis?
|
| 2 |
|
| 3 | Zignis is a command-line tool framework, based on [Yargs](https://www.npmjs.com/package/yargs). It can be used to make your commands and scripts interact with your project.
|
| 4 |
|
| 5 | # Features
|
| 6 |
|
| 7 | - Less concepts(command, plugin, hook, config), but more powerful.
|
| 8 | - All of plugins, commands, configs can be overridden in conventional order.
|
| 9 | - Easily register a command to Zignis, so you can combine your team toolbox or workflow to Zignis
|
| 10 | - A plugable REPL, it's not just like native node REPL, you can hook anything into REPL, which is also support await.
|
| 11 | - Ability to extend command's subcommands in other plugins.
|
| 12 | - Provide a simple code generator mechanism.
|
| 13 | - Support organization plugins.
|
| 14 |
|
| 15 | # Principles
|
| 16 |
|
| 17 | - Consistency
|
| 18 | - Flexibility
|
| 19 | - Efficiency
|
| 20 |
|
| 21 | # Installation & Usage
|
| 22 |
|
| 23 | ```
|
| 24 | $ npm i -g zignis
|
| 25 | $ zignis help
|
| 26 |
|
| 27 | zignis
|
| 28 |
|
| 29 | Command：
|
| 30 | zignis init Init basic zignis config file and directories [aliases: i]
|
| 31 | zignis make <template> Generate component sample code [aliases: m]
|
| 32 | zignis new <name> [repo] [branch] Create a new project from specific repo [aliases: n]
|
| 33 | zignis repl Play with REPL [aliases: r]
|
| 34 | zignis script [file] Execute a script [aliases: scr]
|
| 35 | zignis status Show Zignis status [aliases: st]
|
| 36 |
|
| 37 | Option：
|
| 38 | --version 显示版本号 [boolean]
|
| 39 | -h, --help 显示帮助信息 [boolean]
|
| 40 | ```
|
| 41 |
|
| 42 | Please refer to the documentation to learn how to use Zignis, because you need to do the integration by yourself to make Zignis work for your project.
|
| 43 |
|
| 44 | # Requirements
|
| 45 |
|
| 46 | - Node > v8.0
|
| 47 |
|
| 48 | # Documentation
|
| 49 |
|
| 50 | - [Chinese(中文)](https://zignis.js.org/)
|
| 51 | - [English(英文)], TBD
|
| 52 |
|
| 53 | # License
|
| 54 |
|
| 55 | MIT
|