@w-way/aliyun-oss-utils

alioss

介绍

一款接入阿里云的工具

安装

// 全局安装
npm i aliyunoss -g 
// 查看是否安装成功,查看版本
as -v
// 设置默认阿里云配置文件路径
as set [路径]

配置文件参数说明

// 支持json文件和js文件（配置参考阿里云）
{
    "region":"region",
    "accessKeyId":"accessKeyId",
    "accessKeySecret":"accessKeySecret",
    "bucket":"bucket"
}
module.exports = {
    "region":"region",
    "accessKeyId":"accessKeyId",
    "accessKeySecret":"accessKeySecret",
    "bucket":"bucket"
}

阿里云帮助中心

命令演示说明

[]中括号里的是可选参数
<>简括号里的是必填参数

查看列表

as list <rootName> [type] -c --config [config] -m max [max]
// 阿里云文件列表,[rootName(默认为根)] [type (file|dir,默认不区分)]
// rootName  文件根路径
// type      文件类型: 不填表示全部 可选：file(文件) | dir(文件夹)  
// config    阿里云配置文件路径: 不填使用默认路径  
// max       最多查询条数: 不填查询100条

上传文件

as put <localPath> <ossName> -c --config [config]
// localPath  本地路径
// ossName    上传的相对路径
// config     阿里云配置文件路径: 不填使用默认路径  

下载文件

as get <ossName> [localPath] -c --config [config]
// ossName      阿里云服务器上的文件名
// localPath    下载到本地的文件名：不填使用ossName
// config       阿里云配置文件路径: 不填使用默认路径

删除文件

as del <ossName> -c --config [config] -t --type [type]
// ossName      阿里云服务器上的文件名
// config       阿里云配置文件路径: 不填使用默认路径
// type         文件类型: 不填表示file 可选：file(文件) | dir(文件夹)  

通过js引入说明

1. 引入使用

const Aliossutils = require("aliyun-oss-utils")
const instance = new Aliossutils(config)                  // 实例化
instance.list()                                     // 调取api

参数 config：阿里oss配置(选填，不填读取配置路径)
参考 配置文件参数说明

2. 静态方法说明

Aliossutils.getConfig()                             // 获取软件配置
Aliossutils.setOssConfigPath("inputPath")           // 设置默认阿里云配置文件路径
Aliossutils.getOssConfig()                          // 获取默认阿里云配置文件路径

3. 实例方法说明

• list

instance.list({
    rootName, 
    type,
    max
})

其余参数参考查看列表

• put

instance.put({ 
    localPath, 
    ossName 
})

其余参数参考上传文件

• get

instance.put({ 
    localPath, 
    ossName 
})

其余参数参考下载文件

• del

instance.put({ 
    ossName, 
    type,
})

其余参数参考删除文件