tiny-cli: OpenTiny-CLI开发工具

代码拉取完成,页面将自动刷新

扫描微信二维码支付

取消

支付完成

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

3 Star 5 Fork 7

OpenTiny/tiny-cli

代码 Issues 0 Pull Requests 0 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

新建文件新建 Diagram 文件

新建子模块

上传文件

分支 20

标签 7

贡献代码

同步代码

创建 Pull Request

了解更多

对比差异通过 Pull Request 同步

同步更新到分支

通过 Pull Request 同步

将会在向当前分支创建一个 Pull
Request,合入后将完成同步

Kagol chore: release v1.1.1 fee7946

159 次提交

.github

.husky

config/typescript

docs

packages

.all-contributorsrc

.editorconfig

.eslintignore

.eslintrc.js

.gitignore

.prettierignore

.prettierrc.js

CHANGELOG.md

CONTRIBUTING.md

CONTRIBUTING.zh-CN.md

LICENSE

README.md

README.zh-CN.md

commitlint.config.js

lerna.json

package-lock.json

package.json

tsconfig.json

README

MIT

# Tiny CLI

简体中文 | [English](README.md)

> Tiny CLI是前端工程化命令行工具

[Tiny CLI官网](https://opentiny.design/tiny-cli/home)

## Installation

打开git bash、zsh等命令行工具,输入如下命令后回车:

```bash
$ npm i @opentiny/cli -g
```

等待片刻,待安装完成之后在终端执行 `$ tiny -v`,正常返回版本信息,表示安装成功。

注意:tiny-cli 依赖 nodejs(12.x以上) 、 npm 环境,在安装tiny时,请确保本机已安装了nodejs和npm

## Docs

* [CLI工具设计文档](docs/tool-design.md)
* 使用者文档
	* [tiny-cli介绍](docs/use-summary.md)
	* [安装tiny-cli](docs/use-install.md)
	* [tiny-cli基础命令详解](docs/use-cli.md)
	* [使用tiny-cli套件](docs/use-toolkit.md)
	* [使用tiny-cli插件](docs/use-plugin.md)
	* [tiny-cli配置文件](docs/use-config.md)
* 开发者文档
	* [tiny-cli API](docs/api.md)
	* [套件开发指南](docs/dev-toolkit.md)
	* [插件开发指南](docs/dev-plugin.md)

## Usage

可在终端输入`$ tiny -h` 查看tiny使用帮助

```bash
 tiny 使用帮助: $ tiny [command] [options]

$ tiny 显示tiny帮助信息,若目录下有使用的套件,则会同时显示套件的帮助信息
 $ tiny init [toolkitName] 初始化套件
 $ tiny update [name] 更新tiny模块
 $ tiny list [type] 插件列表
 $ tiny i 安装npm模块
 $ tiny clear 清空 tiny 的本地缓存
 $ tiny help 显示套件帮助信息
 $ tiny [name] 其他调用插件命令

Options:

-h, --help 显示tiny帮助信息
 -v, --version 显示tiny版本

提示:
 套件 - 若想查看项目中所使用的套件帮助信息,请在项目根目录执行该命令.
 插件 - 若想查看插件的帮助信息,请使用 tiny [name] help 命令, eg : tiny git help
```

### Quick start

以 `@opentiny/tiny-toolkit-dev` 套件为例,讲解开发流程。

1. 初始化项目

```bash
	# 创建并进入项目文件夹
	$ mkdir my-project && cd $_
	
	# 初始化dev的开发环境
	$ tiny init dev
	```
	
3. 开启本地环境

```bash
	# 开启dev的开发环境
	$ tiny start
	```

4. 项目编译及打包

```bash
	$ tiny build
	```

## ChangeLog

[CHANGELOG.md](CHANGELOG.md)

## Support

开发及使用过程中的问题,可以在代码仓库新建issue

## 开发文档

### 前置条件

* 确保已安装lerna,未安装可执行命令: `npm install --global lerna`
* 确保node版本在v12.x及以上

### 本地开发调试命令

首次:`npm run init`
开发:`npm run dev`
构建:`npm run build`
本地验证: `npm run link`

### 构建流程

根目录执行`npm run build`即可,会打包出lib目录和dist目录。

## 参与贡献

如果你对我们的开源项目感兴趣,欢迎加入我们!

参与贡献之前请先阅读[贡献指南](CONTRIBUTING.md)。

- 添加官方小助手微信 opentiny-official,加入技术交流群
- 加入邮件列表 opentiny@googlegroups.com

## 开源协议

[MIT](LICENSE)

MIT License Copyright (c) 2022 - present Tiny CLI Authors. Copyright (c) 2022 - present Huawei Cloud Computing Technologies Co., Ltd. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.