# sao

> Futuristic scaffolding tool ⚔

Latest version **1.7.1** (published 2020-05-12) · MIT license · 0 weekly downloads

## Install

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

Provides the command `sao`.

## 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.7.1 |
| Published | 2020-05-12 |
| First published | 2015-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 21 |
| Unpacked size | 38 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1046 |
| Author | egoist |
| Maintainers | egoist, kchan, rem |
| Keywords | sao, generator, egoist, yeoman, template, scaffold, automation, kirito, simple, easy, workflow |

## Links

- npm: https://www.npmjs.com/package/sao
- Repository: https://github.com/saojs/sao
- Homepage: https://github.com/saojs/sao#readme
- Issues: https://github.com/saojs/sao/issues
- npm.io page: https://npm.io/package/sao

## Dependencies (21)

- [cac](https://npm.io/package/cac.md) ^6.3.8
- [ini](https://npm.io/package/ini.md) ^1.3.5
- [ora](https://npm.io/package/ora.md) ^3.0.0
- [conf](https://npm.io/package/conf.md) ^2.0.0
- [majo](https://npm.io/package/majo.md) ^0.6.2
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [joycon](https://npm.io/package/joycon.md) ^2.1.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.0
- [hash-sum](https://npm.io/package/hash-sum.md) ^1.0.2
- [inquirer](https://npm.io/package/inquirer.md) ^6.2.0
- [log-update](https://npm.io/package/log-update.md) ^2.3.0
- [micromatch](https://npm.io/package/micromatch.md) ^3.1.10
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^6.0.5
- [yarn-global](https://npm.io/package/yarn-global.md) ^1.1.0
- [resolve-from](https://npm.io/package/resolve-from.md) ^4.0.0
- [jstransformer](https://npm.io/package/jstransformer.md) ^1.0.0
- [is-binary-path](https://npm.io/package/is-binary-path.md) ^2.0.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^2.5.0
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^1.1.0
- [jstransformer-ejs](https://npm.io/package/jstransformer-ejs.md) ^0.2.0
- [parse-package-name](https://npm.io/package/parse-package-name.md) ^0.1.0

## Recent versions

- 1.7.1 (latest) — 2020-05-12
- 2.0.0-beta.1 (beta) — 2020-07-27
- 1.7.2-canary.145.30b2bdb.0 (canary) — 2020-07-19
- 1.0.0-alpha.7 (next) — 2018-08-01
- 1.7.2-canary.145.575704a.0 — 2020-07-19
- 1.7.2-canary.145.eee8525.0 — 2020-07-19
- 1.7.2-canary.145.3f693ca.0 — 2020-07-19
- 1.7.2-canary.145.1220f64.0 — 2020-07-19
- 1.7.0 — 2019-09-30
- 1.6.1 — 2018-12-02
- 1.6.0 — 2018-12-02
- 1.5.0 — 2018-12-01
- 1.4.1 — 2018-11-26
- 1.4.0 — 2018-11-25
- 1.3.2 — 2018-11-20
- … 104 more at https://npm.io/package/sao/versions

## README

<p align="center">
<img src="https://user-images.githubusercontent.com/8784712/47992262-650b1780-e127-11e8-9e58-6c75e22ad99f.png" width="150" />
</p>

<p align="center">
<br>
<a href="https://npmjs.com/package/sao"><img src="https://img.shields.io/npm/v/sao.svg?style=flat" alt="NPM version"></a> <a href="https://npmjs.com/package/sao"><img src="https://img.shields.io/npm/dm/sao.svg?style=flat" alt="NPM downloads"></a> <a href="https://circleci.com/gh/saojs/sao"><img src="https://img.shields.io/circleci/project/saojs/sao/master.svg?style=flat" alt="Build Status"></a> <a href="https://packagephobia.now.sh/result?p=sao"><img src="https://packagephobia.now.sh/badge?p=sao" alt="install size"></a> <a href="https://github.com/egoist/donate"><img src="https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&amp;style=flat" alt="donate"></a> <a href="https://chat.egoist.moe"><img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg?style=flat" alt="chat"></a>
</p>

## Motivation

**SAO** was made because **yeoman**, while powerful, is too complex. **vue-cli**, on the other hand, is more than a scaffolding tool and lacks some important features like *unit testing*. **SAO** combines the powerful core features of **yeoman** with the simplicity of **vue-cli** into a single application.

**SAO** is compatible with:

- Regular git repo (simply download it)
- SAO generator as git repo
- SAO generator as npm package
- SAO generator in local folder

⚡ ️**Both repo and npm package can be used offline.**

## Quick Start

```bash
npm i -g sao

# An official generator for creating a Node.js project
# Generate from git repo
sao saojs/sao-nm my-module
# Or from npm package (npm.im/sao-nm)
sao nm my-module
```

For detailed usage please head to https://saojs.org

## Related

- [Awesome SAO](https://github.com/saojs/awesome-sao) - A curated list of delightful SAO resources.
- [SAO articles on medium.com](https://medium.com/saojs).

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

**SAO** © [EGOIST](https://github.com/egoist), Released under the [MIT](https://egoist.mit-license.org/) License.<br>
Authored and maintained by EGOIST with help from contributors ([list](https://github.com/saojs/sao/contributors)).

> [egoist.sh](https://egoist.sh) · GitHub [@EGOIST](https://github.com/egoist) · Twitter [@_egoistlily](https://twitter.com/_egoistlily)

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