@neosjs/cli/README.md

Neos(奈欧斯)是一个帮助开发者快速地创建 Vue3 应用并自动配置项目编译的脚手架

# Neos

Neos(奈欧斯)是一个帮助开发者快速地创建 Vue3 应用并自动配置项目编译的脚手架。
配置完整、格式统一, 有点儿意思！

特性：

- ⚡️ [Vue 3](https://cn.vuejs.org/) + [Vite 4](https://github.com/vitejs/vite) (^4.0.4), [pnpm](https://pnpm.io/)(^3.2.45)
- 🗂 [Vue Router](https://router.vuejs.org/) (^4.1.6) --- **可选配置**
- 🍍 [使用 Pinia 的状态管理](https://pinia.vuejs.org) (^2.0.28) + [数据持久化](https://prazdevs.github.io/pinia-plugin-persistedstate/)(^2.1.1) --- **可选配置**
- ⛓ [数据请求](https://docs.neosjs.com/hooks/request.html) (^2.0.6) --- **可选配置**
- 📜 支持 `H5模版`、`PC模版`
- 🦾 天然支持 [TypeScript](https://www.typescriptlang.org/) (^4.7.4) --- **默认配置**
- 🔥 使用 [新的 `<script setup>` 语法](https://github.com/vuejs/rfcs/pull/227)
- 🤙🏻 默认开启 [响应性语法糖](https://vuejs.org/guide/extras/reactivity-transform.html)
- ⚓ 自带 `useAsync`、`useLoading`、`useOnline`、`useWindowSizeFn` 等Hooks
- 🔖 自带 `SvgIcon` 组件
- 🎨 [UnoCSS](https://github.com/unocss/unocss) - 高性能且极具灵活性的即时原子化 CSS 引擎 (^0.45.22) --- **可选配置**
- 📥 [API 自动加载](https://github.com/antfu/unplugin-auto-import) - 直接使用 Composition API 无需引入 (^0.11.2) --- **可选配置**
- 📦 [组件自动化加载](https://github.com/antfu/unplugin-vue-components) (^0.22.5) --- **可选配置**
- 📲 [PWA](https://github.com/antfu/vite-plugin-pwa) (^0.14.1) --- **可选配置**
- ✅ [移动端 VConsole 功能](https://github.com/vadxq/vite-plugin-vconsole) (^1.3.1) --- **H5默认添加**
- 🔐 [https 开发服务提供证书支持](https://github.com/liuweiGL/vite-plugin-mkcert)vite-plugin-mkcert (^1.11.0) --- **默认配置**
- 🏝 [SVG Icons支持](https://github.com/vbenjs/vite-plugin-svg-icons) (^2.0.1) --- **默认配置**
- ⚙️ [Vitest](https://github.com/vitest-dev/vitest) 进行单元测试 (^0.26.3) --- **可选配置**
- 🖇 [代码提交规范](https://commitlint.js.org/) (^17.4.2) --- **默认配置**
- 🔬 [Commit 校验](https://typicode.github.io/husky/) (^8.0.3) --- **默认配置**
- 🧱 [代码检查](https://eslint.org/) (^8.22.0)  --- **默认配置**
- 💻 [统一 VsCode 配置](https://code.visualstudio.com/)

## 安装

```shell
npm install -g @neosjs/cli
```

## 使用

### 创建项目

```shell
neos create <app-name>
```

### 查看当前系统信息

```shell
neos info
```

### 打开一个网址

```shell
neos open <http-url>
```

### 生成一个随机数

```shell
neos random <length>
```

对于CLI选项，使用-h(或——help)参数:

```shell
neos -h
```