Scaleway CLI (v2)
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.
Basic commands
# 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
Environment
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.
Reference documentation
| Namespace | Description | Documentation |
|---|
account | User related data | CLI / API |
applesilicon | Apple silicon API | CLI / API |
autocomplete | Autocomplete related commands | CLI |
baremetal | Baremetal API | CLI / API |
billing | Billing API | CLI / API |
cockpit | Cockpit API | CLI / API |
config | Config file management | CLI |
container | Serverless Container API | CLI / API |
dns | DNS API | CLI / API |
feedback | Send feedback to the Scaleway CLI Team! | CLI |
flexibleip | Flexible IP API | CLI / API |
function | Serverless Function API | CLI / API |
iam | IAM API | CLI / API |
info | Get info about current settings | CLI |
init | Initialize the config | CLI |
instance | Instance API | CLI / API |
iot | IoT API | CLI / API |
ipam | IPAM API | CLI / API |
jobs | Serverless Jobs API | CLI / API |
k8s | Kapsule API | CLI / API |
lb | Load Balancer API | CLI / API |
marketplace | Marketplace API | CLI |
mnq | Messaging and Queueing API | CLI / API |
mongodb | Managed db Mongodb API | CLI / API |
object | Object-storage utils | CLI / API |
rdb | Database RDB API | CLI / API |
redis | Redis API | CLI / API |
registry | Container registry API | CLI / API |
secret | Secret manager API | CLI / API |
shell | Start Shell mode | CLI |
tem | Transactional Email API | CLI / API |
vpc-gw | VPC Gateway API | CLI / API |
vpc | VPC API | CLI / API |
Build it yourself
Build Locally
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
Build with Docker
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
Development
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.
Automate CLI actions with Scaleway Serverless Jobs
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:
Reach Us
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.