ks3

# KS3 命令行文档 ## 说明本工具主要是满足用户`上传`和`下载`文件的需求,尤其是大文件情况.在上传和下载过程中都会进行断点续传,节省时间和带宽资源. ## 安装 ### 准备条件 1. 安装[nodejs](http://nodejs.org/)以及[npm](https://www.npmjs.org) (新版nodejs自带npm，不需要安装npm） ### 安装 - 命令行工具安装 ``` npm install -g ks3@cmd ``` ## 命令解释 ### ks3 reset 重置开发者配置,清空历史记录 ``` ks3 reset ``` ### ks3 init 主要执行初始化操作.在初始化过程中,可以指定开发者的`AK`和`SK`. 命令行使用分为两种模式: 直接指定,或者进入交互模式.在`交互模式`下,会指导你填写必须的参数.如果所需参数没有提供完全,也会进入`交互模式`. ``` ks3 init -a [ak] -s [sk] -b [bucket] ``` `-a --ak` : 开发者的AK(Access Key) `-s --sk` : 开发者AK对应的SK(Access Key Secret) `-b --bucket` : 开发要使用哪个Bucket,非必须,可以在每个具体命令中指定 `-r --region` : Bucket所在Region，非必须，可在每个具体命令中指定，有效值为：BEIJING|HONGKONG|AMERICA|SHANGHAI 也可以直接输入`ks3 init`进入交互模式 ### ks3 upload 上传文件以及文件夹.程序会根据文件大小进行`简单上传`和`分块上传`. ``` ks3 upload -p [path] -b [bucket] -k [key] --withsubdir -r [region] ``` `-p --path` : 开发者制定要上传文件夹或者文件的地址 `-b --bucket` : 指定上传文件存储的bucket `-k --key` : 如果上传的path为文件,则为文件名,如果上传的path是文件夹,则为文件夹名称 `--withsubdir` : 在上传文件夹的过程中,是否上传子文件夹,默认不上传,加上本参数,上传子文件夹内容 `-r --region` : Bucket所在Region，有效值为：BEIJING|HONGKONG|AMERICA|SHANGHAI 例如: 1. 把`/Users/ren/Desktop/Life\ Of\ Johnson.txt`传递到 `ks3-sdk-test` bucket根目录下 ``` ks3 upload /Users/ren/Desktop/Life\ Of\ Johnson.txt // 或者 ks3 upload "/Users/ren/Desktop/Life Of Johnson.txt" // 然后进入交互模式填写bucket,key和region // 也可以直接传递参数 ks3 upload "/Users/ren/Desktop/Life Of Johnson.txt" -b ks3-sdk-test -k "Life Of Johnson.txt" -r BEIJING ``` 说明：不指定region则默认为北京region 2. 把 `D:\Program Files (x86)\Foxmail` 整个文件夹(包括子文件夹)上传,如下: ``` ks3 upload -p "D:\Program Files (x86)\Foxmail" --withsubdir // 进入交互模式填写bucket和key ``` 也可以直接输入`ks3 upload`进入交互模式 ### ks3 download 下载金山云存储的文件,可以进行断点续传.现在暂时只能下载文件,不能下载文件夹 ``` ks3 download -b $bucket -k $key -p $localpath ``` `-b --bucket` : 指定下载文件所在的bucket `-k --key` : 指定下载文件对应的key,**注意,key不包含bucket名称** `-p --path` : 下载文件的本地存储地址 `-r --region` : Bucket所在Region，有效值为：BEIJING|HONGKONG|AMERICA|SHANGHAI 例如: 1. 把`ks3-sdk-test` bucket下的 `test_download.txt` 下载到本地 `D盘` 根目录下,并且重命名为`test.txt` ``` ks3 download -k test_download.txt -p d:\test.txt // 由于没有输入bucket名称,会进入交互模式,让你输入bucket名称 // 或者直接指定bucket名称 ks3 download -b ks3-sdk-test -k test_download.txt -p d:\test.txt -r BEIJING ``` 说明：不指定region则默认为北京region ## 帮助说明 - 如何获取自己的`AK`和`SK`? 访问 [官方文档-权限管理](http://ks3.ksyun.com/doc/console/index.html#%E6%9D%83%E9%99%90%E7%AE%A1%E7%90%86) - 什么是`分块上传`? 简单说就是把大文件拆成小文件上传,并且全部传完以后再合并生成大文件.避免大文件在上传过程中出意外,必须从头开始上传的问题.查看[官方文档-分块上传](http://ks3.ksyun.com/doc/api/multipart_upload.html)