cos-uploader 2.0.0rc1

CLI tool for uploading files to Tencent COS

COS Uploader

跨平台的腾讯云对象存储上传工具

• 支持 Windows、Linux、MacOS
• 可以用于图片上传（图床）、文件分享等
• 带有日志记录功能，可以查看上传历史
• 支持通过系统自带的工具快速上传文件（Windows：「发送到」；MacOS：「快捷指令」）

安装

我们推荐使用 pipx 安装 COS Uploader，请参见其官网来安装 pipx。

# 安装方法 1：使用 pipx 安装 (推荐)
pipx install cos-uploader

# 安装方法 2：使用 pip 安装
pip3 install cos-uploader

# 安装方法 3：手动创建虚拟环境安装 (可能会出现未经测试的问题)
mkdir -p ~/.cos-uploader/bin
python3 -m venv ~/.cos-uploader/venv
source ~/.cos-uploader/venv/bin/activate
pip install cos-uploader
ln -s ~/.cos-uploader/venv/bin/cos-uploader* ~/.cos-uploader/bin
echo 'export PATH="$PATH:$HOME/.cos-uploader/bin"' >> ~/.profile

使用

安装完成后，请运行 cos-uploader-install 来初始化配置，然后编辑 ~/.cos-uploader/config.toml 来配置 COS Uploader。

请确保 secret-id、secret-key、bucket、region 配置正确，否则无法上传文件。

如果输入 cos-uploader-install 后提示找不到命令，可能是 PATH 环境变量没有生效或没有配置，请依次检查：

• 重新启动当前 shell，如 exec zsh 或 exec bash
• 重新启动当前终端，在 GUI 下应退出终端应用（iTerm2 下按 Command ⌘ + Q、Windows Terminal 下关闭窗口）
• 查看 PATH 变量
  • 使用 pipx，需要根据 pipx 的提示将 ~/.local/bin 添加到 PATH
  • Windows 版的 Python 默认不会将 Scripts 添加到 PATH，需要手动添加。打开 设置——系统——关于 点击右侧「高级系统设置」，添加 C:\Users\<用户名>\AppData\Roaming\Python\<Python版本>\Scripts 到 PATH
  • 如果使用了手动创建虚拟环境安装（安装方法 3），请将 ~/.cos-uploader/bin 添加到 PATH

Windows 的特殊配置

在运行 cos-uploader-install 时，会自动创建「发送到」菜单项。

在配置完成后，右键单击文件，在菜单中选择「发送到」，然后选择「COS Uploader」即可上传文件。

MacOS 的特殊配置

请导入 COS Uploader 快捷指令

导入完成后，请打开「快捷指令」App，选择左上角菜单中的「快捷指令——设置——高级」，勾选「允许运行脚本」。

完成后，可以在 Finder 的「快速操作」菜单中选择「COS Uploader」来上传文件。

优化海外使用体验

如果您上传文件的设备位于中国大陆境外，请在配置中将 oversea_upload 设置为 true，这样可以提高上传速度。

如果您的文件使用者位于中国大陆境外，请在配置中将 [domains] 节的 enabled 数组添加 accelerate，并使用输出的 Acc URL 来访问文件。

构建

COS Uploader 使用 Poetry 构建。请先安装 Poetry，然后执行以下命令：

git clone https://github.com/baobao1270/cos-uploader.git
cd cos-uploader
poetry install

要发布到 PyPI，请执行以下命令：

poetry publish --build

许可

COS Uploader 使用 MIT 协议