Scaleway CLI

Scaleway CLI（v2）

Scaleway CLI 是一款工具，可帮助你直接在终端中管理 Scaleway 基础设施。

请参阅文档，了解各种 CLI 命令的完整参考。

安装

使用包管理器（推荐）

包管理器只需一条命令即可安装和升级 Scaleway CLI。 我们推荐使用这种安装方式，简单又可靠：

Homebrew

在 macOS/Linux 上使用 Homebrew 安装最新稳定版本：

brew install scw

Arch Linux

从 Arch Linux 官方仓库安装最新稳定版本。 例如，使用 pacman：

pacman -S scaleway-cli

Chocolatey

在 Windows 上使用 Chocolatey 安装最新稳定版本（软件包）：

choco install scaleway-cli

手动安装

已发布的二进制文件

我们为 darwin（macOS）、GNU/Linux 和 Windows 平台提供静态编译的二进制文件。 你只需下载与你的平台兼容的二进制文件，并将其放入 PATH 中的目录：

Linux

curl -s https://raw.githubusercontent.com/scaleway/scaleway-cli/main/scripts/get.sh | sh

Windows

你可以在此处下载最新版本：https://github.com/scaleway/scaleway-cli/releases
此官方指南介绍了如何将工具添加到 PATH。

Docker 镜像

你可以像运行任何 Docker 镜像一样使用 CLI：

docker run -i --rm scaleway/cli:latest

有关在 Docker 中运行 CLI 的更多详细信息，请参阅此处。

入门

设置配置

安装最新版本后，只需运行初始化命令并按照指引操作即可！:dancer:

scw init

此命令会设置你的配置文件、身份验证和自动补全。 注意：你需要准备一个 API-key（access-key + access-secret），请务必在 Scaleway Web 控制台创建一个。

基本命令

# Create an instance server
scw instance server create type=DEV1-S image=ubuntu_noble zone=fr-par-1 tags.0="scw-cli"

# List your servers
scw instance server list

# Create a Kubernetes cluster named foo with cilium as CNI, in version 1.17.4 and with a pool named default composed of 3 DEV1-M and with 2 tags
scw k8s cluster create name=foo version=1.17.4 pools.0.size=3 pools.0.node-type=DEV1-M pools.0.name=default tags.0=tag1 tags.1=tag2

环境

你可以通过环境变量配置设置或启用功能。

用于覆盖配置的变量请参阅配置文档。 要启用 Beta 功能，可在环境中设置 SCW_ENABLE_BETA=1。

参考文档

Namespace	描述	文档
account	用户相关数据	CLI / API
applesilicon	Apple silicon API	CLI / API
autocomplete	自动补全相关命令	CLI
baremetal	裸金属 API	CLI / API
billing	账单 API	CLI / API
cockpit	Cockpit API	CLI / API
config	配置文件管理	CLI
container	无服务器容器 API	CLI / API
dns	DNS API	CLI / API
feedback	向 Scaleway CLI 团队发送反馈！	CLI
flexibleip	弹性 IP API	CLI / API
function	无服务器函数 API	CLI / API
iam	IAM API	CLI / API
info	获取当前设置的信息	CLI
init	初始化配置	CLI
instance	实例 API	CLI / API
iot	IoT API	CLI / API
ipam	IPAM API	CLI / API
jobs	无服务器作业 API	CLI / API
k8s	Kapsule API	CLI / API
lb	负载均衡器 API	CLI / API
marketplace	Marketplace API	CLI
mnq	消息与队列 API	CLI / API
mongodb	托管数据库 Mongodb API	CLI / API
object	对象存储实用工具	CLI / API
rdb	数据库 RDB API	CLI / API
redis	Redis API	CLI / API
registry	容器镜像仓库 API	CLI / API
secret	密钥管理器 API	CLI / API
shell	启动 Shell 模式	CLI
tem	事务性电子邮件 API	CLI / API
vpc-gw	VPC 网关 API	CLI / API
vpc	VPC API	CLI / API

自行构建

本地构建

推荐使用 mise 构建和开发 CLI。 安装 mise，然后运行 mise install 获取所需工具（Go、golangci-lint、gotestsum 等）。

mise install               # install required tools
mise run build:cli         # build the CLI binary

运行 mise tasks ls 列出所有可用任务，并运行 mise run <task> --help 查看特定任务的标志。 有关构建、测试和 lint 命令的完整概述，请参阅 AGENTS.md。

或者，如果你的环境中有 >= Go 1.27，可以安装 HEAD 版本来测试最新功能，或参与贡献。 请注意，此开发版本可能包含错误；如果需要稳定性，请使用已标记的发行版。

go install github.com/scaleway/scaleway-cli/v2/cmd/scw@latest

使用 Docker 构建

你可以使用 Docker 构建 scw CLI。如果已安装 Docker，可以运行：

docker build -t scaleway/cli .

构建完成后，你可以像运行任何镜像一样使用 CLI：

docker run -i --rm scaleway/cli

有关在 Docker 中运行 CLI 的更多详细信息，请参阅此处

开发

此代码仓库尚处于早期阶段，仍在积极开发中。 如果你想了解如何贡献，请阅读 CONTRIBUTING.md。

使用 Scaleway Serverless Jobs 自动执行 CLI 操作

你可以通过安排 Scaleway Serverless Jobs 来自动执行 CLI 操作。这样，你就可以在指定时间或间隔运行 Scaleway CLI 命令，而无需手动执行。

分步指南请参阅以下教程：

• 使用 Serverless Jobs 启动和关闭实例
• 创建 Managed MongoDB® 数据库的快照
• 创建数据库的定期计划备份和快照
• 创建 Instance 的快照

联系我们

我们很乐意听取反馈。 欢迎提交 GitHub issue，也可以通过 Scaleway Slack 社区 联系我们， 我们在 #opensource 等你。