# enkel_cli

> enkel cli

Latest version **3.0.1** (published 2021-06-02) · 0 weekly downloads

## Install

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

Provides the commands `bbt`, `enkel`.

## 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 | 3.0.1 |
| Published | 2021-06-02 |
| First published | 2017-11-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 3.8 MB |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| Author | Keith |
| Maintainers | liangshan |
| Keywords | enkel, cli |

## Links

- npm: https://www.npmjs.com/package/enkel_cli
- Repository: https://gitee.com/cli5/enkel
- npm.io page: https://npm.io/package/enkel_cli

## Dependencies (17)

- [ora](https://npm.io/package/ora.md) ^3.4.0
- [walk](https://npm.io/package/walk.md) ^2.3.14
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [lowdb](https://npm.io/package/lowdb.md) ^1.0.0
- [hostile](https://npm.io/package/hostile.md) ^1.3.3
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.3
- [webpack](https://npm.io/package/webpack.md) ^4.40.2
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [commander](https://npm.io/package/commander.md) ^3.0.1
- [socket.io](https://npm.io/package/socket.io.md) ^2.3.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.2.0
- [portfinder](https://npm.io/package/portfinder.md) ^1.0.24
- [http-server](https://npm.io/package/http-server.md) ^0.12.3
- [log-symbols](https://npm.io/package/log-symbols.md) ^3.0.0
- [webpack-cli](https://npm.io/package/webpack-cli.md) ^3.3.9
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^2.0.0
- [webpack-dev-server](https://npm.io/package/webpack-dev-server.md) ^3.8.1

## 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

- 3.0.1 (latest) — 2021-06-02
- 3.0.0 — 2021-06-02
- 2.2.0 — 2021-05-26
- 2.1.16 — 2021-04-20
- 2.1.15 — 2021-04-20
- 2.1.13 — 2021-04-20
- 2.1.12 — 2020-05-28
- 2.1.11 — 2019-10-10
- 2.1.10 — 2019-10-10
- 2.1.9 — 2019-10-10
- 2.1.8 — 2019-10-10
- 2.1.7 — 2019-10-10
- 2.1.6 — 2019-10-09
- 2.1.5 — 2019-10-09
- 2.1.3 — 2019-10-09
- … 20 more at https://npm.io/package/enkel_cli/versions

## README

# enkel_cli

> 模板管理器，管理各种项目模板，快速生成模板项目。支持自定义模板仓库，支持动态配置模板变量

## 安装

```
sudo npm install -g enkel_cli
```

## 可用命令

```
enkel --version
bbt --version
```

### enkel 命令

#### 1、可视化创建模板项目

```
enkel ui
```

#### 2、模板仓库管理

```
// 显示所有模板仓库
enkel repository ls

// 显示当前使用中的模板仓库
enkel repository current

// 设置模板仓库
enkel repository use <仓库名>

// 新增自定义模板仓库
enkel repository add <仓库名> <仓库地址>

// 删除模板仓库
enkel repository del <仓库名>

// 显示帮助信息
enkel repository help
```

#### 3、自定义模板

> 支持的自定义模板仓库类型：GitHub、GitLab、Bitbucket，如默认模板仓库地址为：https://github.com/enkeljs/enkel-templates

##### 3.1 自定义模板项目目录结构

    ├── templates
        ├── 模板项目A
        |   ├── ...
        |   ├── package.json // 可选文件，脚手架能自动识别项目根目录的package.json文件，并支持自动安装依赖
        |   └── enkel.config.js // 必需存在的文件
        ├── 模板项目B
        |   ├── ...
        |   └── enkel.config.js
        └── ...
  
##### 3.2 enkel.config.js文件

> 所有的描述应该尽可能的语义化，用于可视化创建模板项目。可动态添加占位符。占位符要以 $$ 开头和结尾，中间可包含大、小写字母、数字、下划线 (_)

```
module.exports = {
  description: 'PWA模板', // 模板项目的语义化描述，用于可视化创建项目-选择模板
  placeholder: { // 可动态添加不限个数的占位符
    $$PLACEHOLDER$$: { // 占位符以 $$ 开头和结尾，中间可包含大、小写字母、数字、下划线 (_)
      description: '占位符描述' // 占位符的语义化描述，用于可视化创建项目-占位符替换
    }
  }
}
```

### bbt 命令

```
bbt help
```

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