logo
0
0
WeChat Login
docs: 添加英文文档并更新中文文档

coscli-bin

简体中文 | English

腾讯云 COS CLI - tencentyun/coscli 的 Node.js 封装,用于腾讯云对象存储的命令行工具。

功能特性

  • 📦 零配置自动安装:执行 npm install 即可使用
  • 🔄 版本锁定:包版本与 coscli 版本一致
  • 🎯 平台感知:自动为您的操作系统和架构下载正确的二进制文件
  • 🔐 校验和验证:所有下载均进行 SHA-256 验证
  • 🔧 可自定义:支持自定义镜像和系统级二进制文件
  • 📝 类型安全:完整的 TypeScript 支持,提供自动补全

安装

npm install coscli-bin -D

或全局安装以使用命令行:

npm install -g coscli-bin

使用

命令行

安装后,您可以直接使用 coscli 命令。详细的命令行使用方法请参考 coscli 官方文档

编程 API

import coscli from 'coscli-bin'; // 执行命令 await coscli.ls(['cos://mybucket/path/']); await coscli.cp(['localfile.txt', 'cos://mybucket/path/']); await coscli.sync(['./local', 'cos://mybucket/path/']); // 或使用 exec 进行更多控制 import { exec, execWithOutput } from 'coscli-bin'; // 执行命令并获取输出 await exec('ls', ['cos://mybucket/path/']); // 捕获输出 const { stdout } = await execWithOutput('version'); console.log(stdout);

配置

环境变量

变量类型描述
COSCLI_OVERRIDE_VERSIONstring安装不同版本的 coscli(忽略 package.json)
COSCLI_SKIP_DOWNLOADboolean跳过后安装的二进制文件下载
COSCLI_BIN_PATHstring使用已存在的 coscli 二进制文件
COSCLI_MIRROR_BASE_URLstring自定义下载镜像 URL
COSCLI_SKIP_CHECKSUMboolean跳过 SHA-256 校验和验证
COSCLI_QUIETboolean静默安装输出

使用示例

安装指定版本:

COSCLI_OVERRIDE_VERSION=1.0.7 npm install coscli

跳过下载(适用于 CI 环境):

COSCLI_SKIP_DOWNLOAD=1 npm install

使用自定义二进制文件:

COSCLI_BIN_PATH=/usr/local/bin/coscli npm start

使用自定义镜像:

COSCLI_MIRROR_BASE_URL=https://mirror.example.com/coscli npm install

支持的平台

  • macOS: amd64, arm64
  • Linux: 386, amd64, arm, arm64
  • Windows: 386, amd64

开发

# 克隆仓库 git clone https://github.com/your-org/coscli-npm.git cd coscli-npm # 安装依赖 npm install # 构建 npm run build # 运行测试 npm test

许可证

MIT

相关链接