update document

This commit is contained in:
tickstep 2024-03-03 21:56:48 +08:00
parent a7034e300f
commit 62c50726a5
6 changed files with 26 additions and 113 deletions

View File

@ -38,7 +38,6 @@
- [同步备份文件](#同步备份文件) - [同步备份文件](#同步备份文件)
- [更多命令](#更多命令) - [更多命令](#更多命令)
- [常见问题](#常见问题) - [常见问题](#常见问题)
- [如何获取RefreshToken](#如何获取refreshtoken)
- [如何开启Debug调试日志](#如何开启debug调试日志) - [如何开启Debug调试日志](#如何开启debug调试日志)
- [第一步](#第一步) - [第一步](#第一步)
- [第二步](#第二步) - [第二步](#第二步)
@ -186,11 +185,12 @@ aliyunpan > help
``` ```
### 登录 ### 登录
需要先登录,已经登录过的可以跳过此步。 需要先登录,已经登录过的可以跳过此步。登录是在浏览器上进行,你需要进行两次登录。
RefreshToken获取教程请查看[如何获取RefreshToken](#如何获取RefreshToken)
```shell ```shell
aliyunpan > login -RefreshToken=32994cd2c43...4d505fa79 aliyunpan > login
请在浏览器打开以下链接进行登录链接有效时间为5分钟。
注意:你需要进行一次授权一次扫码的两次登录。
https://openapi.alipan.com/oauth/authorize?client_id=cf9f70e8fc61430f8ec5ab5cadf31375&redirect_uri=https%3A%2F%2Fapi.tickstep.com%2Fauth%2Ftickstep%2Faliyunpan%2Ftoken%2Fopenapi%2F8206f0.....fb5db6b40336%2Fauth&scope=user:base,file:all:read,file:all:write
阿里云盘登录成功: tickstep 阿里云盘登录成功: tickstep
aliyunpan:/ tickstep$ aliyunpan:/ tickstep$
``` ```
@ -202,7 +202,6 @@ aliyunpan:/ tickstep(备份盘)$ drive
# DRIVE ID 网盘名称 # DRIVE ID 网盘名称
1 11519221 备份盘 1 11519221 备份盘
2 1311893110 资源库 2 1311893110 资源库
3 61104421 相册
输入要切换的网盘 # 值 > 2 输入要切换的网盘 # 值 > 2
切换到网盘:资源库 切换到网盘:资源库
@ -248,10 +247,6 @@ aliyunpan:/ tickstep$ download IMG_0106.JPG
下载结束, 时间: 4秒, 数据总量: 1.48MB 下载结束, 时间: 4秒, 数据总量: 1.48MB
aliyunpan:/ tickstep$ aliyunpan:/ tickstep$
``` ```
下载支持两种链接类型1-默认类型 2-阿里ECS环境类型
在普通网络下下载速度可以达到10MB/s在阿里ECS必须是"经典网络"类型的机器环境下下载速度单文件可以轻松达到20MB/s多文件可以达到100MB/s
![](./assets/images/download_file_ecs_speed_screenshot.gif)
![](./assets/images/download_file_speed_screenshot.gif)
### 上传文件 ### 上传文件
```shell ```shell
@ -270,9 +265,6 @@ aliyunpan:/ tickstep$ upload /Users/tickstep/Downloads/apt.zip /tmp
上传结束, 时间: 18秒, 数据总量: 21.00MB 上传结束, 时间: 18秒, 数据总量: 21.00MB
``` ```
上传支持两种链接类型1-默认类型 2-阿里ECS环境类型
在阿里ECS必须是"经典网络"类型的机器环境下上传速度单文件可以轻松达到30MB/s多文件可以达到100MB/s
![](./assets/images/upload_file_speed_screenshot.gif)
### 同步备份文件 ### 同步备份文件
同步备份功能支持备份本地文件到云盘备份云盘文件到本地双向同步备份三种模式。支持JavaScript插件对备份文件进行过滤。 同步备份功能支持备份本地文件到云盘备份云盘文件到本地双向同步备份三种模式。支持JavaScript插件对备份文件进行过滤。
@ -307,18 +299,6 @@ aliyunpan:/ tickstep$ sync start -ldir "/tickstep/Documents/设计文档" -pdir
更多更详细的命令请查看手册:[命令手册](docs/manual.md)。 更多更详细的命令请查看手册:[命令手册](docs/manual.md)。
# 常见问题 # 常见问题
## 如何获取RefreshToken
需要通过浏览器获取refresh_token。这里以Chrome浏览器为例其他浏览器类似。
打开 [阿里云盘网页](https://www.aliyundrive.com/drive) 并进行登录然后F12按键打开浏览器调试菜单按照下面步骤进行
![](./assets/images/how-to-get-refresh-token.png)
或者直接在控制台输入以下命令获取
```
JSON.parse(localStorage.getItem("token")).refresh_token
```
![](./assets/images/how-to-get-refresh-token-cmd.png)
## 如何开启Debug调试日志 ## 如何开启Debug调试日志
当需要定位问题或者提交issue的时候抓取log则需要开启debug日志。步骤如下 当需要定位问题或者提交issue的时候抓取log则需要开启debug日志。步骤如下
@ -353,5 +333,5 @@ Web网页端
# 鸣谢 # 鸣谢
本项目大量借鉴了以下相关项目的功能&成果 本项目大量借鉴了以下相关项目的功能&成果
> [tickstep/cloudpan189-go](https://github.com/tickstep/cloudpan189-go) > [tickstep/cloudpan189-go](https://github.com/tickstep/cloudpan189-go)
> [kazutoiris/ali_ecc](https://github.com/kazutoiris/ali_ecc) > [kazutoiris/ali_ecc](https://github.com/kazutoiris/ali_ecc)

Binary file not shown.

After

Width:  |  Height:  |  Size: 173 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 196 KiB

View File

@ -9,8 +9,7 @@
* [获取当前帐号](#获取当前帐号) * [获取当前帐号](#获取当前帐号)
* [切换阿里云盘帐号](#切换阿里云盘帐号) * [切换阿里云盘帐号](#切换阿里云盘帐号)
* [退出阿里云盘帐号](#退出阿里云盘帐号) * [退出阿里云盘帐号](#退出阿里云盘帐号)
* [刷新Token](#刷新Token) * [切换网盘(备份盘/资源库)](#切换网盘)
* [切换网盘(备份盘/资源库/相册)](#切换网盘)
* [获取网盘配额](#获取网盘配额) * [获取网盘配额](#获取网盘配额)
* [切换工作目录](#切换工作目录) * [切换工作目录](#切换工作目录)
* [输出工作目录](#输出工作目录) * [输出工作目录](#输出工作目录)
@ -26,7 +25,6 @@
+ [设置分享文件/目录](#设置分享文件目录) + [设置分享文件/目录](#设置分享文件目录)
+ [列出已分享文件/目录](#列出已分享文件目录) + [列出已分享文件/目录](#列出已分享文件目录)
+ [取消分享文件/目录](#取消分享文件目录) + [取消分享文件/目录](#取消分享文件目录)
+ [分享秒传链接](#分享秒传链接)
* [同步备份功能](#同步备份功能) * [同步备份功能](#同步备份功能)
+ [常用命令说明](#常用命令说明) + [常用命令说明](#常用命令说明)
+ [备份配置文件说明](#备份配置文件说明) + [备份配置文件说明](#备份配置文件说明)
@ -45,8 +43,7 @@
+ [5.Token刷新失败发送外部通知](#5.Token刷新失败发送外部通知) + [5.Token刷新失败发送外部通知](#5.Token刷新失败发送外部通知)
* [显示和修改程序配置项](#显示和修改程序配置项) * [显示和修改程序配置项](#显示和修改程序配置项)
- [常见问题Q&A](#常见问题Q&A) - [常见问题Q&A](#常见问题Q&A)
* [1. 如何获取RefreshToken](#1-如何获取RefreshToken) * [1. 如何开启Debug调试日志](#1-如何开启Debug调试日志)
* [2. 如何开启Debug调试日志](#2-如何开启Debug调试日志)
# 命令列表及说明 # 命令列表及说明
## 注意 ## 注意
@ -86,25 +83,32 @@ aliyunpan help login
## 登录阿里云盘帐号 ## 登录阿里云盘帐号
### 登录 ### 登录
当前支持使用RefreshToken进行登录。RefreshToken请参考 [1. 如何获取RefreshToken](#1-如何获取RefreshToken) 获取 当前支持在浏览器进行登录,请输入一下命令按照步骤进行即可。
``` ```
aliyunpan login aliyunpan login
``` ```
### 例子 ### 例子
``` ```
按照引导步骤登录 aliyunpan > login
aliyunpan login 请在浏览器打开以下链接进行登录链接有效时间为5分钟。
请输入RefreshToken, 回车键提交 > 626a27b6193f4c5ca6ef0....... 注意:你需要进行一次授权一次扫码的两次登录。
https://openapi.alipan.com/oauth/authorize?client_id=cf9f70e8fc61430f8ec5ab5cadf31375&redirect_uri=https%3A%2F%2Fapi.tickstep.com%2Fauth%2Ftickstep%2Faliyunpan%2Ftoken%2Fopenapi%2F8206f0.....fb5db6b40336%2Fauth&scope=user:base,file:all:read,file:all:write
命令行指定RefreshToken登录 阿里云盘登录成功: tickstep
aliyunpan login -RefreshToken=626a27b6193f4c5ca6ef0....... aliyunpan:/ tickstep$
使用二维码方式进行登录,按照引导步骤进行
aliyunpan login -QrCode
``` ```
目前登录全部采用网页登录由于aliyunpan 融合了阿里官方Open 接口+网页Web端接口所以你需要进行两次登录。输入 login 命令
![](../assets/images/login-screenshot-1.png)
复制到浏览器打开链接,会自动跳转到阿里 Open 接口授权登录页面,点击允许完成第一次登录
![](../assets/images/login-screenshot-2.png)
接着页面会自动跳转到网页接口登录页面使用阿里APP扫码完成第二次登录
![](../assets/images/login-screenshot-3.png)
然后切换回 aliyunpan 程序,按下 Enter 按键完成登录即可
![](../assets/images/login-screenshot-4.png)
## 列出帐号列表 ## 列出帐号列表
``` ```
@ -140,23 +144,6 @@ aliyunpan logout
程序会进一步确认退出帐号, 防止误操作. 程序会进一步确认退出帐号, 防止误操作.
## 刷新Token
由于阿里云盘的RefreshToken是会过期的为了延长最大过期时间需要定期刷新Token建议每小时刷新一次。
调用该命令可以自动刷新RefreshToken并保存到配置文件中但是有一个前提即Token必须还没有过期如果Token已经过期是无法刷新的则只能重新登录。
```
刷新当前登录用户
aliyunpan token update
刷新所有登录的用户
aliyunpan token update -mode 2
```
如果你的aliyunpan工具是在Linux中运行则建议你使用crontab定时任务进行Token自动刷新例如
```
每小时执行一次Token刷新任务
*/60 * * * * /<your path>/aliyunpan token update -mode 2
```
## 切换网盘 ## 切换网盘
程序默认工作在文件网盘下,如需切换到相册网盘,可以使用本命令进行切换。 程序默认工作在文件网盘下,如需切换到相册网盘,可以使用本命令进行切换。
``` ```
@ -226,11 +213,6 @@ aliyunpan ll /我的文档
``` ```
## 下载文件/目录 ## 下载文件/目录
下载支持两种链接类型1-默认类型 2-阿里ECS环境类型
在普通网络下下载速度可以达到10MB/s在阿里ECS必须是"经典网络"类型的机器环境下下载速度单文件可以轻松达到20MB/s多文件可以达到100MB/s
![](../assets/images/download_file_ecs_speed_screenshot.gif)
![](../assets/images/download_file_speed_screenshot.gif)
``` ```
aliyunpan download <网盘文件或目录的路径1> <文件或目录2> <文件或目录3> ... aliyunpan download <网盘文件或目录的路径1> <文件或目录2> <文件或目录3> ...
aliyunpan d <网盘文件或目录的路径1> <文件或目录2> <文件或目录3> ... aliyunpan d <网盘文件或目录的路径1> <文件或目录2> <文件或目录3> ...
@ -274,10 +256,6 @@ aliyunpan d /我的文档
自动跳过下载重名的文件! 自动跳过下载重名的文件!
## 上传文件/目录 ## 上传文件/目录
上传支持两种链接类型1-默认类型 2-阿里ECS环境类型
在阿里ECS必须是"经典网络"类型的机器环境下上传速度单文件可以轻松达到30MB/s多文件可以达到100MB/s
![](../assets/images/upload_file_speed_screenshot.gif)
``` ```
aliyunpan upload <本地文件/目录的路径1> <文件/目录2> <文件/目录3> ... <目标目录> aliyunpan upload <本地文件/目录的路径1> <文件/目录2> <文件/目录3> ... <目标目录>
aliyunpan u <本地文件/目录的路径1> <文件/目录2> <文件/目录3> ... <目标目录> aliyunpan u <本地文件/目录的路径1> <文件/目录2> <文件/目录3> ... <目标目录>
@ -311,22 +289,6 @@ aliyunpan upload -exn "\.jpg$" -exn "\.mp3$" C:/Users/Administrator/Video /视
5)排除 myfile.txt 文件:-exn "^myfile.txt$" 5)排除 myfile.txt 文件:-exn "^myfile.txt$"
``` ```
## 手动秒传上传文件
通过秒传链接上传文件到网盘秒传链接可以通过share命令获取
```
aliyunpan rapidupload <秒传链接1> <秒传链接2> <秒传链接3> ...
```
### 例子:
```
# 如果秒传成功, 则保存到网盘路径 /file.dmg
aliyunpan rapidupload "aliyunpan://file.dmg|752FCCBFB2436A6FFCA3B287831D4FAA5654B07E|7005440|"
# 如果秒传成功, 则保存到网盘路径 /pan_folder/file.dmg
aliyunpan rapidupload "aliyunpan://file.dmg|752FCCBFB2436A6FFCA3B287831D4FAA5654B07E|7005440|pan_folder"
```
## 创建目录 ## 创建目录
``` ```
aliyunpan mkdir <目录> aliyunpan mkdir <目录>
@ -429,24 +391,6 @@ aliyunpan share c <shareid_1> <shareid_2> ...
``` ```
目前只支持通过分享id (shareid) 来取消分享. 目前只支持通过分享id (shareid) 来取消分享.
### 分享秒传链接
秒传链接支持所有类型的文件分享可以突破阿里的分享限制。得到的链接可以使用import或者rapidupload命令保存到自己网盘中。
秒传链接只支持文件分享,不支持文件夹。如果指定文件夹会创建文件夹下所有文件的秒传链接。
```
aliyunpan share mc <文件/目录1> <文件/目录2> ...
例子
# 创建文件 1.mp4 的秒传链接
aliyunpan share mc 1.mp4
# 创建文件 1.mp4 的秒传链接,但链接隐藏相对路径
aliyunpan share mc -hp 1.mp4
# 创建文件夹 share_folder 下面所有文件的秒传链接
aliyunpan share mc share_folder/
```
## 同步备份功能 ## 同步备份功能
同步备份功能支持备份本地文件到云盘备份云盘文件到本地双向同步备份三种模式。支持JavaScript插件对备份文件进行过滤。 同步备份功能支持备份本地文件到云盘备份云盘文件到本地双向同步备份三种模式。支持JavaScript插件对备份文件进行过滤。
指定本地目录和对应的一个网盘目录,以备份文件。网盘目录必须和本地目录独占使用,不要用作其他用途,不然备份可能会有问题。 指定本地目录和对应的一个网盘目录,以备份文件。网盘目录必须和本地目录独占使用,不要用作其他用途,不然备份可能会有问题。
@ -1222,18 +1166,7 @@ aliyunpan config set -transfer_url_type 2
``` ```
# 常见问题Q&A # 常见问题Q&A
## 1 如何获取RefreshToken ## 1 如何开启Debug调试日志
需要通过浏览器获取refresh_token。这里以Chrome浏览器为例其他浏览器类似。
打开 [阿里云盘网页](https://www.aliyundrive.com/drive) 并进行登录然后F12按键打开浏览器调试菜单按照下面步骤进行
![](../assets/images/how-to-get-refresh-token.png)
或者直接在控制台输入以下命令获取
```
JSON.parse(localStorage.getItem("token")).refresh_token
```
![](../assets/images/how-to-get-refresh-token-cmd.png)
## 2 如何开启Debug调试日志
当需要定位问题或者提交issue的时候抓取log则需要开启debug日志。步骤如下 当需要定位问题或者提交issue的时候抓取log则需要开启debug日志。步骤如下
### 第一步 ### 第一步