diff --git a/README.en-US.md b/README.en-US.md new file mode 100644 index 0000000..f28be84 --- /dev/null +++ b/README.en-US.md @@ -0,0 +1,104 @@ + + +# wangpancli + +A cross-platform cloud drive command-line tool that provides a simple and user-friendly CLI interface, making it easy to manage your cloud storage files directly from the terminal. + +## Supported Cloud Drives + +| Drive Name | Drive Type | Support Status | +|---------|-------|---------| +| Baidu Netdisk | baidu | Supported ✅ | +| Alibaba Cloud Drive | aliyun | Planned 🚧 | +| Quark Cloud Drive | quark | Planned 🚧 | +| Tencent Weiyun | weiyun | Planned 🚧 | + +More cloud drive services are being added continuously... + +## Installation + +```bash +pip install wangpancli +``` + +After installation, you can use any of the following commands: +- `wangpancli` - Full command +- `pancli` - Short alias +- `wpcli` - Short alias + +## Basic Configuration + +Account information must be configured before first use: + +```bash +wangpancli config [网盘类型] +``` + +For example, to configure Baidu Netdisk: + +```bash +wangpancli config baidu +``` + +During the configuration process, you will need to provide the authorization information required by the respective cloud drive platform. +For Baidu Netdisk, you need to provide: +1. AppKey and SecretKey obtained from the Baidu Netdisk Open Platform +2. Authorization code obtained via the generated authorization link + +For instructions on obtaining configuration parameters, please refer to: [Baidu Netdisk Open Platform Documentation](https://pan.baidu.com/union/doc/ol0rsap9s) + +## Usage + +### List Files + +```bash +# List local files +wangpancli ls /local/path + +# List cloud drive files (e.g., Baidu Netdisk) +wangpancli ls baidu:/remote/path +``` + +### Copy Files + +```bash +# Copy from local to cloud drive +wangpancli cp /local/file baidu:/remote/path + +# Download from cloud drive to local +wangpancli cp baidu:/remote/file /local/path + +# Copy local files +wangpancli cp /source/file /dest/path +``` + +### Create Directories + +```bash +# Create directory locally +wangpancli mkdir /local/path + +# Create directory on cloud drive +wangpancli mkdir baidu:/remote/path +``` + +## Features + +- Supports multiple mainstream cloud drive services +- Unified CLI interface for easy switching between different cloud drives +- Supports chunked upload for large files +- Supports file transfer between local storage and cloud drives +- Supports batch upload of folders +- Supports colorized CLI output to distinguish between files and directories +- Provides multiple command aliases (wangpancli/pancli/wpcli) + +## Dependencies + +- loguru>=0.7.2 +- requests>=2.32.3 +- rich>=13.7.0 +- Python>=3.10.0 + +## License + +[GNU License](LICENSE)