This commit is contained in:
@@ -0,0 +1,75 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# 功能概览
|
||||
|
||||
kit 提供命令行工具、脚本组装、运维管理三大核心能力。
|
||||
|
||||
## 命令行工具
|
||||
|
||||
kit 内置跨平台的常用命令,解决 Windows/Linux 脚本兼容性问题:
|
||||
|
||||
| 命令 | 说明 |
|
||||
|------|------|
|
||||
| `info` | 查看系统信息 |
|
||||
| `mkdir` | 创建目录 |
|
||||
| `rm` | 删除文件/目录 |
|
||||
| `cp` | 复制文件 |
|
||||
| `mv` | 移动文件 |
|
||||
| `zip` | 压缩/解压 |
|
||||
| `md5` | 计算 MD5 |
|
||||
| `readJson` | 读取 JSON 文件 |
|
||||
| `writeJson` | 写入 JSON 文件 |
|
||||
|
||||
## 远程操作
|
||||
|
||||
| 命令 | 说明 |
|
||||
|------|------|
|
||||
| `scp` | 跨主机文件传输 |
|
||||
| `remoteShell` | SSH 远程执行命令 |
|
||||
|
||||
## 模块管理
|
||||
|
||||
kit 可作为模块管理器,从远程仓库安装、升级、卸载工具:
|
||||
|
||||
```shell
|
||||
# 安装模块
|
||||
kit install myapp
|
||||
|
||||
# 指定版本安装
|
||||
kit install myapp@1.0
|
||||
|
||||
# 查看已安装版本
|
||||
kit list myapp
|
||||
|
||||
# 切换版本
|
||||
kit use myapp@1.0
|
||||
|
||||
# 回滚到上一个版本
|
||||
kit rollback myapp
|
||||
|
||||
# 删除版本
|
||||
kit remove myapp@1.0
|
||||
```
|
||||
|
||||
## 脚本组装
|
||||
|
||||
kit 支持通过脚本文件(`kitx.js`)组合各种能力,实现工作流自动化:
|
||||
|
||||
```js
|
||||
// kitx.js
|
||||
async function main() {
|
||||
console.log("开始部署...");
|
||||
mkdir("./dist");
|
||||
cp("./src/*", "./dist/");
|
||||
scp("./dist/", "server:/app/");
|
||||
remoteShell({host: "server"}, "cd /app && restart.sh");
|
||||
}
|
||||
```
|
||||
|
||||
运行脚本:
|
||||
|
||||
```shell
|
||||
kit run
|
||||
```
|
||||
+29
-4
@@ -4,19 +4,44 @@ sidebar_position: 1
|
||||
|
||||
# 安装
|
||||
|
||||
kit 支持 Windows(x86_64)、Linux(x86_64)、 Linux(arm64)、 Alpine 等多个执行平台。
|
||||
kit 是一个跨平台命令行工具,支持以下平台:
|
||||
|
||||
下载地址:http://baishe.fullstack.club:5244/
|
||||
| 平台 | 架构 | 说明 |
|
||||
|------|------|------|
|
||||
| Windows | x86_64 | `kit.exe` |
|
||||
| Linux | x86_64 | 现代 glibc(Ubuntu 20.04+) |
|
||||
| Linux | x86_64 | Kylin V10 低版本 glibc |
|
||||
|
||||
## 下载
|
||||
|
||||
前往首页下载对应平台的二进制文件:
|
||||
|
||||
- **Windows**: [kit.exe](https://pub-98ee77ce79984c2cad0dc1c300901158.r2.dev/data/windows/kit.exe)
|
||||
- **Linux (现代 glibc)**: [kit](https://pub-98ee77ce79984c2cad0dc1c300901158.r2.dev/data/linux/kit)
|
||||
- **Linux (Kylin V10)**: [kit.zip](https://pub-98ee77ce79984c2cad0dc1c300901158.r2.dev/data/kylin/kit.zip)
|
||||
|
||||
下载后将可执行文件添加到系统 `PATH` 中即可使用。
|
||||
|
||||
## 远程仓库
|
||||
|
||||
kit 支持从远程仓库安装和管理模块。配置仓库地址:
|
||||
|
||||
```shell
|
||||
kit config remoteServer http://baishe.fullstack.club:5244/dav
|
||||
kit config remoteAuth cheney@722V587
|
||||
```
|
||||
|
||||
## 信雅达内部仓库
|
||||
### 信雅达内部仓库
|
||||
|
||||
```shell
|
||||
kit config remoteServer http://172.16.17.230:5244/dav
|
||||
kit config remoteAuth kit@kitkit
|
||||
```
|
||||
```
|
||||
|
||||
## 验证
|
||||
|
||||
配置完成后,运行以下命令验证仓库连接:
|
||||
|
||||
```shell
|
||||
kit remote
|
||||
```
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# 更多
|
||||
等多文档请移步 -> **[Kit 辅助开发工具](https://flowus.cn/fullstack/share/9e90b5b7-cea7-44d7-9231-e5d8a6c807f9)**
|
||||
# 更多文档
|
||||
|
||||
详细的 API 文档和使用示例,请参考:
|
||||
|
||||
- **在线文档**: [Kit 辅助开发工具](https://flowus.cn/fullstack/share/9e90b5b7-cea7-44d7-9231-e5d8a6c807f9)
|
||||
- **代码仓库**: [git.honor3.com/Fullstack/kit.program](http://git.honor3.com/Fullstack/kit.program)
|
||||
|
||||
Reference in New Issue
Block a user