# sakitam-cli

> A simple cli scaffolding for generate project

Latest version **0.0.4** (published 2018-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install sakitam-cli
pnpm add sakitam-cli
yarn add sakitam-cli
bun add sakitam-cli
```

Provides the commands `sakitam`, `sakitam-init`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2018-07-05 |
| First published | 2018-07-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 22 |
| Unpacked size | 29.3 KB |
| Known vulnerabilities | 0 (+26 in 3 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 3 |
| Author | sakitam-fdd |
| Maintainers | sakitam-fdd |
| Keywords | sakitam, cli, plugin |

## Links

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

## Dependencies (22)

- [ora](https://npm.io/package/ora.md) ^2.1.0
- [uuid](https://npm.io/package/uuid.md) ^3.2.1
- [async](https://npm.io/package/async.md) ^2.6.1
- [axios](https://npm.io/package/axios.md) ^0.18.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [figlet](https://npm.io/package/figlet.md) ^1.2.0
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.2
- [semver](https://npm.io/package/semver.md) ^5.5.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.2
- [tildify](https://npm.io/package/tildify.md) ^1.2.0
- [download](https://npm.io/package/download.md) ^5.0.3
- [inquirer](https://npm.io/package/inquirer.md) ^5.2.0
- [commander](https://npm.io/package/commander.md) ^2.15.1
- [git-clone](https://npm.io/package/git-clone.md) ^0.1.0
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.4
- [user-home](https://npm.io/package/user-home.md) ^2.0.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.0.11
- [metalsmith](https://npm.io/package/metalsmith.md) ^2.3.0
- [multimatch](https://npm.io/package/multimatch.md) ^2.1.0
- [consolidate](https://npm.io/package/consolidate.md) ^0.15.1
- [read-metadata](https://npm.io/package/read-metadata.md) ^1.0.0
- [validate-npm-package-name](https://npm.io/package/validate-npm-package-name.md) ^3.0.0

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

- 0.0.4 (latest) — 2018-07-05
- 0.0.3 — 2018-07-04
- 0.0.2 — 2018-07-04
- 0.0.1 — 2018-07-02

## README

## sakitam-cli

> A scaffolding tool for rapid develop vue & react and other project。

[![Build Status](https://travis-ci.org/sakitam-fdd/sakitam-cli.svg?branch=master)](https://www.travis-ci.org/sakitam-fdd/sakitam-cli)
[![NPM downloads](https://img.shields.io/npm/dm/sakitam-cli.svg)](https://npmjs.org/package/sakitam-cli)
[![Npm package](https://img.shields.io/npm/v/sakitam-cli.svg)](https://www.npmjs.org/package/sakitam-cli)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/sakitam-fdd/sakitam-cli/master/LICENSE)

## Quickstart

```bash
npm install -g sakitam-cli
# or
yarn global add sakitam-cli

// list available templete
sakitam list
// output usage information
sakitam list -h
// params: Template view under the specified warehouse
sakitam list -u aurorafe -p vue
// output usage information
sakitam init -h
// generate project
sakitam init sakitam-gis/maptalks-plugin-tpl-base project
// Defaults associated repository `aurorafe`, so, you can use
sakitam init vue-template-webpack project
// Use cached template
sakitam init --offline vue-template-webpack project
cd project
npm i
npm run dev
```

## example

```bash
sakitam list vue // list vue project templete
sakitam list react // list react project templete
sakitam list library // list javascript library templete
sakitam list react-component // list react component templete
sakitam list vue-component // list vue component templete

// init
sakitam init vue-template-webpack project // repo
sakitam init aurorafe/vue-template-webpack project // user/repo
sakitam init --offline vue-template-webpack project // Use cached template
sakitam init -c direct:https://github.com/aurorafe/vue-template-webpack.git project // Use git clone ~ direct is important
```

## Development

```bash
git clone https://github.com/sakitam-fdd/sakitam-cli.git
cd sakitam-cli
npm link
sakitam -h
```

| package name | desc | link |
| :--- | :---------- | :----- |
| `commander ` | `用于处理命令行相关工具` | https://github.com/tj/commander.js |
| `download-git-repo ` | `用于下载git仓库` | https://github.com/flipxfx/download-git-repo |
| `chalk` | `处理终端信息显示的颜色` | https://github.com/chalk/chalk |
| `inquirer` | `交互终端，用于处理用户输入` | https://github.com/SBoudrias/Inquirer.js |
| `ora` | `终端loading解决方案` | https://github.com/sindresorhus/ora |
| `shelljs` | `shell 命令执行, 支持回调` | https://github.com/shelljs/shelljs |
| `read-metadata` | `用于读取json或者yaml元数据文件并返回一个对象` | https://www.npmjs.com/package/read-metadata |
| `minimatch` | `字符匹配工具` | https://github.com/isaacs/minimatch |
| `semver` | `版本号处理工具` | https://github.com/npm/node-semver |
| `user-home` | `用于获取用户的根目录` | https://github.com/sindresorhus/user-home |
| `tildify` | `Convert an absolute path to a tilde path: `/Users/sindresorhus/dev` → `~/dev` | https://github.com/sindresorhus/tildify |
| `rimraf` | `A deep deletion module for node (like `rm -rf`)` | https://github.com/isaacs/rimraf |
| `axios` | `跨平台的ajax处理工具` | https://github.com/axios/axios |
| `handlebars` | `易于构建的模板引擎` | https://github.com/wycats/handlebars.js |
| `metalsmith` | `An extremely simple, pluggable static site generator.` | https://github.com/segmentio/metalsmith |
| `multimatch` | `对 minimatch 的多字符串处理的扩展` | https://github.com/sindresorhus/multimatch |
| `consolidate` | `支持多种模板引擎的渲染` | https://github.com/tj/consolidate.js |
| `consolidate` | `支持多种模板引擎的渲染` | https://github.com/tj/consolidate.js |
| `async` | `用于异步代码的高阶函数和通用模型` | https://github.com/caolan/async |
| `validate-npm-package-name` | `用于验证npm包` | https://github.com/npm/validate-npm-package-name |
| `figlet` | `A FIG Driver written in JavaScript which aims to fully implement the FIGfont spec.` | https://github.com/patorjk/figlet.js |

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