Copy page

Documentation

Scaleway CLI Documentation

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

Installation

With a Package Manager (Recommended)

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

Homebrew

Install the latest stable releaseOpen in new context on macOS/Linux using HomebrewOpen in new context:

Code
brew install scw

Arch Linux

Install the latest stable release on Arch Linux from official repositoriesOpen in new context. For instance with pacman:

Code
pacman -S scaleway-cli

Chocolatey

Install the latest stable release on Windows using ChocolateyOpen in new context (PackageOpen in new context):

Code
choco install scaleway-cli

Manually

Released Binaries

We provide static-compiled binariesOpen in new context 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:

Linux

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

Windows

You can download the last release here: https://github.com/scaleway/scaleway-cli/releasesOpen in new context This official guideOpen in new context explains how to add tools to your PATH.

Docker Image

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

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

See more in-depth information about running the CLI in Docker hereOpen in new context.

Getting Started

Setup your configuration

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

Code
scw init

It will set up your profile, the authentication, and the auto-completion.

Basic commands

Code
# 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

Environment

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

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

Build it yourself

Build Locally

If you have a >= Go 1.13 environment, you can install the HEAD version to test the latest features or to contributeOpen in new context. Note that this development version could include bugs, use tagged releasesOpen in new context if you need stability.

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

Dependencies: We only use go ModulesOpen in new context with vendoring.

Build with Docker

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

Code
docker build -t scaleway/cli .

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

Code
docker run -i --rm scaleway/cli

See more in-depth information about running the CLI in Docker hereOpen in new context

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.mdOpen in new context.

Reach Us

We love feedback. Don't hesitate to open a Github issueOpen in new context or feel free to reach us on Scaleway Slack communityOpen in new context, we are waiting for you on #opensourceOpen in new context.