scaleway/scaleway-cli

scaleway/scaleway-cli

Description: Command Line Interface for Scaleway

Language: Go

License: Apache-2.0

Stars: 976

Forks: 167

Open issues: 263

Created: 2015-03-20T09:45:50Z

Pushed: 2026-06-10T17:08:18Z

Default branch: main

Fork: no

Archived: no

README:

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.

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 release on macOS/Linux using Homebrew:

brew install scw

Arch Linux

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

pacman -S scaleway-cli

Chocolatey

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

choco install scaleway-cli

Manually

Released Binaries

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:

Linux

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

Windows

You can download the last release here:

This official guide explains how to add tools to your PATH.

Docker Image

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](./docs/docker.md)

Getting Started

Setup your configuration

After you [installed](#Installation) the latest release just run the initialization command and let yourself be guided! :dancer:

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.

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](docs/commands/config.md). To enable beta features, you can set SCW_ENABLE_BETA=1 in your environment.

Reference documentation

| Namespace | Description | Documentation | |----------------|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------| | account | User related data | [CLI](./docs/commands/account.md) / API | | applesilicon | Apple silicon API | [CLI](./docs/commands/apple-silicon.md) / API | | autocomplete | Autocomplete related commands | [CLI](./docs/commands/autocomplete.md) | | baremetal | Baremetal API | [CLI](./docs/commands/baremetal.md) / API | | billing | Billing API | [CLI](./docs/commands/billing.md) / API | | cockpit | Cockpit API | [CLI](./docs/commands/cockpit.md) / API | | config | Config file management | [CLI](./docs/commands/config.md) | | container | Serverless Container API | [CLI](./docs/commands/container.md) / API | | dns | DNS API | [CLI](./docs/commands/dns.md) / API | | feedback | Send feedback to the Scaleway CLI Team! | [CLI](./docs/commands/feedback.md) | | flexibleip | Flexible IP API | [CLI](./docs/commands/fip.md) / API | | function | Serverless Function API | [CLI](./docs/commands/function.md) / API | | iam | IAM API | [CLI](./docs/commands/iam.md) / API | | info | Get info about current settings | [CLI](./docs/commands/info.md) | | init | Initialize the config | [CLI](./docs/commands/init.md) | | instance | Instance API | [CLI](./docs/commands/instance.md) / API | | iot | IoT API | [CLI](./docs/commands/iot.md) / API | | ipam | IPAM API | [CLI](./docs/commands/ipam.md) / API | | jobs | Serverless Jobs API | [CLI](./docs/commands/jobs.md) / API | | k8s | Kapsule API | [CLI](./docs/commands/k8s.md) / API | | lb | Load Balancer API | [CLI](./docs/commands/lb.md) / API | | marketplace | Marketplace API | [CLI](./docs/commands/marketplace.md) | | mnq | Messaging and Queueing API | [CLI](./docs/commands/mnq.md) / API | | mongodb | Managed db Mongodb API | [CLI](./docs/commands/mongodb.md) / API | | object…