@baige/deploy
v0.4.0
Published
快速部署,开发者的最爱
Downloads
27
Readme
项目自动化部署的小工具
有新功能,待更新文档 0.3.7 修复文件夹位置错误导致无法使用的 bug
0.3.8 修复兼容环境配置和任务配置不同的 yml 格式
0.3.9 修复 windows 系统下执行 open 命令没打开目标文件夹的 bug
接下来是使用教程(目前只支持 java 和 vue)
工具的四个模块功能
env 环境
如开发环境,测试环境,生产环境等
server 服务器
保存服务器的信息,如登录账号等,用来进行部署时连接服务器使用
task 任务
用来进行部署的配置,一个集群项目往往要配置好几个任务
wor 工作区(项目)
我们不可能永远只开发一个项目,自然也不可能只有一个工作区,wor可以创建多个工作区分别创建不同的task
注:不同的工作区,env、server配置是共享的,task是分开的
share 共享变量区
此配置在任务配置中,多个任务可共享一个配置变量,并且任务配置中也可以向下共享,共享域与java,js的变量作用域类似
注:此配置暂时不可使用终端进行CRUD,只可进行手动配置
4个模块都可以进行增删改查修改配置
1. 首先调用一次命令,用来生成 默认配置 配置存储在用户文件夹的 .deploy 文件夹中
终端执行 depl 或者 deploy
指令:
wor/sv/env/tk --> list/add/del/empty?/set?/get? | [command] -> set [name] ... [name] [value]
taskname --> start/restart/stop/logs/pu
info 查看此工作区信息, 服务器以及环境数据所有工作区共享
参数:
-e -env 选择环境
-f -filename 更改远程文件名
-kn 停止指定名称的进程
-kp 停止指定端口号的进程
2. 查看目前的项目信息
depl info
当前所处项目: xxx
任务: 20
环境: 4
服务器: 16
3. 切换工作区
depl su [name]
4. 环境
添加环境
depl env add
删除环境
depl env delete [name]
修改配置
depl env [name] set [config_name] [values]
获取配置
depl env [name] get
获取配置列表
depl env list
清空配置
depl env empty
5. 服务器
添加服务器
depl server add
删除服务器
depl server delete [name]
修改配置
depl server [name] set [config_name] [values]
获取配置
depl server [name] get
获取配置列表
depl server list
清空配置
depl server empty
下载文件或文件夹
depl server dow target_path out_path
上传文件或文件夹
depl server pu target_path out_path
删除服务器配置
depl server [name] delete
删除目标服务器上的文件或文件夹
depl server [name] delete path
6. 任务
添加任务
depl task add
删除任务
depl task delete [name]
修改配置
depl task [name] set [config_name] [values]
获取配置
depl task [name] get
获取配置列表
depl task list
为任务添加环境
depl task [name] add
删除任务
depl task [name] delete
删除任务的环境
depl task [name] delete [env_name]
清空配置
depl task empty
7. 工作区
添加工作区
depl wor add
删除工作区
depl wor delete [name]
重命名工作区
depl wor rname [name] [new_name]
修改配置
depl wor [name] set [config_name] [values]
获取配置列表
depl wor list
获取配置
depl wor [name] get
8. 任务运行
启动任务
depl [任务名称] start
停止任务
depl [任务名称] stop
重启任务
depl [任务名称] restart
上传任务文件或文件夹
depl [任务名称] push
注:任务名称不可与工具内置关键字相同(server wor env task) 如果相同请使用 depl task [任务名称] [指令] 进行运行
参数介绍
-e 选择环境 如不使用此参数,任务将使用创建任务时设置的defaultEnv进行部署任务
-f 自定义上传到服务器上的文件名称
-info 显示详细的配置信息
-kn 停止指定名称的进程(模糊查询)
-kp 停止占用指定端口的进程
-rlog 删除之前的任务日志
-logname 自定义日志文件名称
9. 小提示
部分关键字都有简化的指令
server -> sv
task -> tk
workspace -> wor
delete -> del
push -> pu
download -> dow