Skip to Content
CLI&SkillCLI 快速开始

CompShare CLI&Skills

在终端管理优云智算 GPU 实例、镜像、云盘、US3 / CFS 存储、独享带宽、团队资源和 MiniMax H3 视频、图片、语音任务。

  • 交互式创建实例，实时查询规格、库存和价格
  • 支持批量生命周期操作、等待状态和跨地域查询
  • 支持可断线恢复的远程任务、状态查询和增量日志读取
  • 支持社区/自定义镜像、云盘、CFS 文件存储、团队额度与账单
  • 支持独享带宽管理，以及 MiniMax H3 视频、Qwen-Image 图片和 IndexTTS 2.5 语音任务
  • 默认中文帮助，可切换英文；所有命令支持 JSON 输出

CLI

安装

pip install compshare-cli
pip install --upgrade compshare-cli

配置

compshare config --name default

凭证保存在 ~/.config/compshare/config.json，支持多个配置：

compshare config list
compshare config use production
compshare --profile production instance list

也可以使用环境变量：

export COMPSHARE_PUBLIC_KEY='...'
export COMPSHARE_PRIVATE_KEY='...'

快速开始

# 查询、创建和查看实例
compshare instance search --region cn-sh2 --zone cn-sh2-02
compshare instance create
compshare instance list --all
 
# 连接实例
compshare instance ssh INSTANCE_ID
 
# 查看帮助
compshare -h
compshare instance -h

命令概览

compshare config     API 凭证配置
compshare doctor     配置、鉴权、网络与 SSH 环境诊断
compshare instance   GPU 实例、规格、库存、价格和生命周期
compshare image      平台、自定义、社区及共享镜像
compshare storage    云盘、US3 挂载和 CFS 文件存储
compshare bandwidth  独享带宽和实例 EIP 带宽归属
compshare minimax    MiniMax H3 视频、图片、语音、Skill 和积分
compshare team       团队、邀请、成员额度、账单和审计

云存储 Pro（CFS）

通过 storage cfs 查询和管理容器可用区的文件存储，容量范围为 50-2048 GiB：

compshare --json storage cfs list
compshare --json storage cfs show CFS_ID
compshare --json storage cfs create --name training --size 100GiB \
  --region cn-bj2 --zone cn-bj2-03 --dry-run
compshare --json storage cfs attach --instance CPOD_ID --dry-run
compshare --json storage cfs resize CFS_ID --size 200GiB \
  --region cn-bj2 --zone cn-bj2-03 --dry-run
compshare --json storage cfs delete CFS_ID \
  --region cn-bj2 --zone cn-bj2-03 --dry-run

检查预演中的价格或影响后，将 --dry-run 替换为 --yes 执行。另有 price、 resize-price、refund 只读询价命令；查询、询价、购买、扩容和删除可通过 --project ID 指定项目。

挂载时如同可用区尚无 CFS，会自动购买 50 GiB、按月计费 1 个周期的存储；运行中的实例 挂载或卸载 CFS 可能重启，请先保存任务。storage us3 attach 对 cpod- 实例也遵循此行为。 创建实例时的 --cfs 仅挂载已有 CFS，找不到时不会自动购买；本地模板也支持该选项， 可用 --no-cfs 覆盖模板配置。

删除 CFS 前请备份数据并卸载挂载实例。delete --recycle 会先尝试卸载已停止实例， 但仍拒绝删除运行中实例挂载的存储。完整约束见 云存储 Pro 接口。

Skills

为 Codex、Claude Code、Cursor 等 AI Agent 安装 CompShare CLI Skill：

npx skills add compshare-cn/compshare-cli --skill compshare-cli

完整说明见 CompShare CLI Skill 。

SDK

如需通过 SDK 集成 CompShare API，可参考独立的 CompShare Developer Examples  仓库。 其中包含 Python、Go、Java、JavaScript 和 PHP 示例，覆盖 API 鉴权、GPU 实例创建、规格配置和状态查询。

Last updated on