# zqjs

> A simple CLI for creating your projects

Latest version **1.0.0** (published 2018-12-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install zqjs
pnpm add zqjs
yarn add zqjs
bun add zqjs
```

Provides the command `zqjs`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-12-05 |
| First published | 2018-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | wenyejie |
| Maintainers | wenyejie |
| Keywords | cli, boohee |

## Links

- npm: https://www.npmjs.com/package/zqjs
- Repository: https://github.com/zhiqicloud/zqjs-cli
- Homepage: https://github.com/zhiqicloud/zqjs-cli#readme
- Issues: https://github.com/zhiqicloud/zqjs-cli/issues
- npm.io page: https://npm.io/package/zqjs

## Dependencies (8)

- [ora](https://npm.io/package/ora.md) ^1.2.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [inquirer](https://npm.io/package/inquirer.md) ^6.0.0
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [commander](https://npm.io/package/commander.md) ^2.16.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.0.11
- [metalsmith](https://npm.io/package/metalsmith.md) ^2.3.0
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^1.0.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

- 1.0.0 (latest) — 2018-12-05

## README

# Zqjs
A simple CLI for creating your projects

## Getting Started

### Install

```shell
npm add zqjs -g
```
### Usage

```
  Usage: zqjs <command>


  Commands:

    add|a      Add a new template
    list|l     List all the templates
    init|i     Generate a new project
    delete|d   Delete a template

  Options:

    -h, --help     output usage information
    -V, --version  output the version number
```

### Commands
#### add | a
This command would help you to add a new template to the `templates.json`, which will be used by `Zqjs` to generate projects.
```
$ zqjs add

? Set the custom name of the template: react
? Owner/name of the template: BooheeFE/react-template
? Branch of the template: master
┌───────────────┬─────────────────────────┬────────┐
│ Template Name │ Owner/Name              │ Branch │
├───────────────┼─────────────────────────┼────────┤
│ vue           │ zhiqicloud/zqjs         │ master │
└───────────────┴─────────────────────────┴────────┘
✔ New template has been added successfully!
```
`Zqjs` use [download-git-repo](https://github.com/flipxfx/download-git-repo) to down load git repos. After answering 3 questions, you'll add a new template to `Zqjs`.

### list | l
It shows you the templates list.
```
$ zqjs list

┌───────────────┬─────────────────────────┬────────┐
│ Template Name │ Owner/Name              │ Branch │
├───────────────┼─────────────────────────┼────────┤
│ vue           │ zhiqicloud/zqjs         │ master │
└───────────────┴─────────────────────────┴────────┘
```

### init | i
After adding new templates, you could use this command to generate your own project by choosing template.
```
$ zqjs init

? Template name: vue
? Project name: demo
? Where to init the project? ./
⠹ Downloading template...

New project has been initialized successfully!
```

### delete | d
To delete a template, you could use this command:
```
$ zqjs delete

? Which template you want to delete? vue
┌───────────────┬─────────────────────────┬────────┐
│ Template Name │ Owner/Name              │ Branch │
├───────────────┼─────────────────────────┼────────┤
│ vue           │ zhiqicloud/zqjs         │ master │
└───────────────┴─────────────────────────┴────────┘
✔ Template has been deleted successfully
```
## Template
The most important part of Zqjs is `template`. All templates' infomation were list in the `templates.json`.
A template means a project sample, which has a simple or complex file structure.

You can create your own templates repository, and push your templates in different branches. All you need to do then is to add the templates into Zqjs's `templates.json`.

## License

[**The MIT License**](LICENSE).

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