https://github.com/zhike-team/zignis

A command-line tool framework, based on Yargs
https://github.com/zhike-team/zignis

cli framework yargs

Last synced: 2 months ago
JSON representation

A command-line tool framework, based on Yargs

• Host: GitHub
• URL: https://github.com/zhike-team/zignis
• Owner: zhike-team
• License: mit
• Created: 2017-08-31T02:49:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T10:39:49.000Z (about 2 years ago)
• Last Synced: 2024-08-08T17:29:52.449Z (6 months ago)
• Topics: cli, framework, yargs
• Language: TypeScript
• Homepage:
• Size: 2.64 MB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# What's Zignis?

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 in same way.

# Features

- Less concepts(command, plugin, hook, config), but more powerful.

- All of plugins, commands, configs can be overridden in conventional order.

- Easily register a command to Zignis, so you can combine your team toolbox or workflow to Zignis

- A plugable REPL, it's not just like native node REPL, you can hook anything into REPL, which is also support await.

- Ability to extend command's subcommands in other plugins.

- Provide a simple code generator mechanism.

- Support organization plugins.

# Principles

- Consistency

- Flexibility

- Efficiency

# Installation & Usage

```

$ npm i -g zignis

$ zignis help

zignis [命令]

命令：

  zignis application                 Application command namespace.                                       [aliases: app]

  zignis hook                        Show hook info

  zignis init                        Init basic config file and directories                                 [aliases: i]

  zignis make             Generate component sample code                               [aliases: generate, g]

  zignis new  [repo] [branch]  Create a new project from specific repo                                [aliases: n]

  zignis repl                        Play with REPL                                                         [aliases: r]

  zignis script [file]               Execute a script                                                     [aliases: scr]

  zignis shell                       Quick shell                                                           [aliases: sh]

  zignis status                      Show environment status info                                          [aliases: st]

  zignis completion                  Generate completion script

选项：

  --version   显示版本号                                                                                          [布尔]

  -h, --help  显示帮助信息                                                                                        [布尔]

Find more information at https://zignis.js.org

```

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.

# Requirements

- Node > v8.0

# Documentation

- [Chinese(中文)](https://zignis.js.org/)

- [English(英文)], TBD

# License

MIT