Scaleway CLI is a tool to help you pilot your Scaleway infrastructure directly from your terminal.
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 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/master/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.
# Create an instance server
scw instance server create type=DEV1-S image=ubuntu_focal 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.
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 |
documentdb |
DocumentDB 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 |
k8s |
Kapsule API | CLI / API |
lb |
Load Balancer API | CLI / API |
marketplace |
Marketplace API | CLI |
mnq |
Messaging and Queueing 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 |
shell |
Start Shell mode | CLI |
tem |
Transactional Email API | CLI / API |
vpc-gw |
VPC Gateway API | CLI / API |
vpc |
VPC API | CLI / API |
If you have a >= Go 1.13 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
Dependencies: We only use go Modules with vendoring.
You can build the scw
CLI with Docker. If you have Docker installed, you can run:
docker build -t scaleway/cli .
Once build, 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.
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.