Repository files navigation

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

Refer to thedocumentation 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 thelatest stable release on macOS/Linux usingHomebrew:

brew install scw

Install the latest stable release on Arch Linux fromofficial repositories.For instance withpacman:

pacman -S scaleway-cli

Install the latest stable release on Windows usingChocolatey (Package):

choco install scaleway-cli

We providestatic-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 yourPATH:

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 yourPATH.

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 Dockerhere

After youinstalled 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 anAPI-key (access-key + access-secret), so be sure to create one on thescaleway web console.

# Create an instance serverscw instance server create type=DEV1-S image=ubuntu_noble zone=fr-par-1 tags.0="scw-cli"# List your serversscw 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 tagsscw 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 inconfig documentation.To enable beta features, you can setSCW_ENABLE_BETA=1 in your environment.

If you have a >= Go 1.13 environment, you can install theHEAD version to test the latest features or tocontribute.Note that this development version could include bugs, usetagged releases if you need stability.

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

Dependencies: We only use goModules with vendoring.

You can build thescw 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 Dockerhere

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

We love feedback.Don't hesitate to open aGithub issue orfeel free to reach us onScaleway Slack community,we are waiting for you on#opensource.