@zhgh/osskit
v1.0.15
Published
ali-oss upload tool. A command is used to upload the specified file and replace the file path
Downloads
6
Readme
OSS 文件上传工具
ali-oss 上传工具,一个命令直接上传指定文件、替换文件路径
快速使用
步骤一
创建配置文件 osskit.config.json
或者 osskit.local.json
(后者的优先级更高)
{
"oss": {
"endpoint": "endpoint",
"accessKeyId": "accessKeyId",
"accessKeySecret": "accessKeySecret",
"bucketName": "bucketName"
},
"list": {
"demo": {
"uploadDir": "/home/xxx/images",
"replaceDir": "/home/xxx"
}
}
}
步骤二
- 使用 npx , 命令行运行
npx @zhgh/osskit -c osskit.config.json -k demo
- or
- 本地安装
npm install -g @zhgh/osskit && osskit -c osskit.config.json -k demo
osskit 命令参数
-c
指定配置文件,不指定默认当前目录下的osskit.config.json
-k
指定操作哪个目录,不指定则运行list
下面的所有目录
配置文件参数
oss 相关
- endpoint 阿里云 oss 对应的 enpoint
- accessKeyId
- accessKeySecret
- bucketName
- storageDirectory 上传到 oss 图片存储目录 (可选填, 默认值为
osskit
)
mapFileName
映射文件名 —— 本地文件和它对应网络地址映射文件的文件名称
- string 可选填
- 默认值
__image.json
list 对象
uploadDir 需要上传的文件夹路径
- string 选填,默认值为空
- 不填默认不进行文件上传操作。
replaceDir 需要替换文件内容的目录路径
- string 选填,默认为空。(如果需要替换操作,
replaceDir
和replaceMapFile
两个参数必须有一个必填) - 若不填则不进行替换文件内容操作,否则对指定目录下的文件进行本地文件地址自动修改为对应的网络地址。
- string 选填,默认为空。(如果需要替换操作,
replaceMapFile 可选,替换映射文件地址 (如果传,则优先使用,否则使用 uploadDir 下的映射地址文件 )