gem-hunter

Scaleway CLI is a tool to help you pilot your Scaleway infrastructure directly from your terminal.

Refer to the documentation for a complete reference of the different CLI commands.

A package manager installs and upgrades the Scaleway CLI with a single command. We recommend this installation mode for more simplicity and reliability:

Install the latest stable release on macOS/Linux using Homebrew:

brew install scw

Install the latest stable release on Arch Linux from official repositories. For instance with pacman:

pacman -S scaleway-cli

Install the latest stable release on Windows using Chocolatey (Package):

choco install scaleway-cli

We provide static-compiled binaries for darwin (macOS), GNU/Linux, and Windows platforms. You just have to download the binary compatible with your platform to a directory available in your PATH:

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

You can download the last release here: https://github.com/scaleway/scaleway-cli/releases
This official guide explains how to add tools to your PATH.

You can use the CLI as you would run any Docker image:

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

See more in-depth information about running the CLI in Docker here

After you installed the latest release just run the initialization command and let yourself be guided! 💃

scw init

It will set up your profile, the authentication, and the auto-completion. NB: you'll need to have an API-key (access-key + access-secret), so be sure to create one on the scaleway web console.

# 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

You can configure your config or enable functionalities with environment variables.

Variables to override config are describe in config documentation. To enable beta features, you can set SCW_ENABLE_BETA=1 in your environment.

The recommended way to build and develop the CLI is with mise. Install mise, then run mise install to fetch the required tools (Go, golangci-lint, gotestsum, etc.).

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

Run mise tasks ls to list all available tasks, and mise run <task> --help to see the flags for a specific task. See AGENTS.md for a complete overview of build, test, and lint commands.

Alternatively, if you have a >= Go 1.27 environment, you can install the HEAD version to test the latest features or to contribute. Note that this development version could include bugs, use tagged releases if you need stability.

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

You can build the scw CLI with Docker. If you have Docker installed, you can run:

docker build -t scaleway/cli .

Once built, you can then use the CLI as you would run any image:

docker run -i --rm scaleway/cli

See more in-depth information about running the CLI in Docker here

This repository is at its early stage and is still in active development. If you are looking for a way to contribute please read CONTRIBUTING.md.

You can automate your CLI actions by scheduling them with Scaleway Serverless Jobs. This allows you to run your Scaleway CLI commands at specific times or intervals without needing to manually execute them.

For step-by-step guides, check out the following tutorials:

• Power on and off your instances using Serverless Jobs
• Create snapshots of a Managed MongoDB® database
• Create recurring scheduled backups and snapshots of a database
• Create snapshots of an Instance

We love feedback. Don't hesitate to open a Github issue or feel free to reach us on Scaleway Slack community, we are waiting for you on #opensource.