Jump toUpdate content

Scaleway Command Line Interface (CLI) - Quickstart

Reviewed on 21 September 2023Published on 21 September 2021

The Scaleway command line interface (CLI) is a tool that allows you to pilot your Scaleway infrastructure and resources directly from your terminal. This page explains how to install and configure the CLI on your local machine.

Tip:

You can also use the integrated Scaleway console CLI by clicking the button at the top of the Scaleway console.

How to install the Scaleway CLI locally

Download the Scaleway CLI using a package manager according to your operating system:

macOS

Install the latest stable release on macOS using Homebrew:

brew install scw

Arch Linux

Install the latest stable release on Arch Linux from official repositories using pacman:

pacman -S scaleway-cli

Windows

Install the latest stable release on Windows using Chocolatey:

choco install scaleway-cli
Tip:

Refer to the Scaleway CLI repository for alternative installation methods.

How to configure the Scaleway CLI

  1. Open a terminal and type the following command to configure the Scaleway CLI on your machine:

    scw init
    Note:

    If you have already configured the CLI, you will see a message like the following:

    Current config is located at /path/to/config.yaml
    access_key: your-access-key
    secret_key: your-secret-key
    default_organization_id: ID-of-your-organization
    default_project_id: ID-of-your-project
    default_region: your-default-region (fr-par)
    default_zone: your-default-zone (fr-par-1)
    Do you want to override the current config? (Y/n):

    Type n if you do not want to edit your configuration.

  2. The following message displays:

    Enter a valid secret-key or an email

    Enter either the email address for your account (you will then be asked for your password), or your API secret Key when prompted by the following message:

  3. The following message displays:

    To improve this tool we rely on diagnostic and usage data.
    Sending such data is optional and can be disabled at any time by running "scw config set send-telemetry=false".
    Do you want to send usage statistics and diagnostics? (Y/n):

    Type y or n according to your preference.

  4. The following message displays:

    To fully enjoy Scaleway CLI we recommend you install autocomplete support in your shell.
    Do you want to install autocomplete? (Y/n):

    Type y or n according to your preference.

  5. The following message displays:

    To enable autocomplete, scw needs to update your shell configuration.
    What type of shell are you using (default: zsh):

    Press enter if the default shell type displayed is the one you are using. Otherwise, enter the correct shell type you are using.

    The configuration is complete, and you are prompted with the message below:

    Initialization completed with success.
  6. Run scw help to display the available commands:

    $ scw help
    Get help about how the CLI works
    USAGE:
    scw help <command>
    AVAILABLE COMMANDS:
    date Get help about how date parsing works in the CLI
    output Get help about how the CLI output works
    FLAGS:
    -h, --help help for help
    GLOBAL FLAGS:
    -c, --config string The path to the config file
    -D, --debug Enable debug mode
    -o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
    -p, --profile string The config profile to use
    Use "scw help [command] --help" for more information about a command.