---
title: Scaleway Command Line Interface (CLI) - Quickstart
description: This page explains how to install and configure the Scaleway CLI locally
tags: devtools cli download-cli scaleway-cli command-line
dates:
  validation: 2025-10-23
  posted: 2021-09-21
---
import Requirements from '@macros/iam/requirements.mdx'


The Scaleway Command Line Interface (CLI) is a tool that allows you to pilot your Scaleway infrastructure and resources directly from your terminal. It is built upon the Scaleway API, and provides a readable and user-friendly interface to interact with Scaleway products programmatically.

This page explains how to install and configure the CLI on your local machine.

<Message type="note">
Refer to the [Scaleway CLI repository](https://github.com/scaleway/scaleway-cli?tab=readme-ov-file#reference-documentation) for more information on the different commands.
</Message>

<Message type="tip">
You can also use the integrated Scaleway console CLI by clicking the button at the top of the [Scaleway console](https://console.scaleway.com/).
</Message>

<Requirements />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/iam/how-to/create-api-keys/)

## 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](https://formulae.brew.sh/formula/scw):

```bash
brew install scw
```

### Arch Linux

Install the latest stable release on Arch Linux from the [official repositories](https://archlinux.org/packages/extra/x86_64/scaleway-cli/) using `pacman`:

```bash
pacman -S scaleway-cli
```

### Windows

Install the latest stable release on Windows using [WinGet](https://learn.microsoft.com/en-us/windows/package-manager/winget/):

```powershell
winget install scw
```

## Manual installation on other OS

Scaleway provides [static compiled binaries](https://github.com/scaleway/scaleway-cli/releases/latest) for GNU/Linux and macOS platforms.
Use the following command to download a binary compatible with your platform directly in your `PATH`:

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

<Message type="tip">
Refer to the [Scaleway CLI repository](https://github.com/scaleway/scaleway-cli) for alternative installation methods.
</Message>

## How to configure the Scaleway CLI

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

    ```
    scw login
    ```

    A browser windows opens and you can login using your Scaleway credentials.

    <Message type="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 `y` to confirm or `n` to cancel the initialization.
    </Message>

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

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

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

5. The Scaleway CLI will now check if an SSH key is present in your local machine in the `id_ecdsa.pub`, `id_ed25519.pub`, and `id_rsa.pub` files. 

    If a key is present, but not associated with the default Scaleway Project, the Scaleway CLI will add this key to the Project defined previously.

    Otherwise, the Scaleway CLI will either confirm that the key is already present in your Scaleway Project, or warn you that no key were found. Refer to the [dedicated documentation](/organizations-and-projects/how-to/create-ssh-key/) to create an SSH key.

6. The configuration is complete, and the message below displays:

    ```
    Initialization completed with success.
    ```

7. Run `scw help` to display the available commands:

    ```bash
    $ 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.
    ```

<Message type="note">
Refer to the [Scaleway CLI repository](https://github.com/scaleway/scaleway-cli?tab=readme-ov-file#reference-documentation) for more information on the different commands.
</Message>

## Automate CLI actions with Scaleway Serverless Jobs

You can automate your CLI actions by scheduling them with Scaleway Serverless Jobs. This allows you to run your Scaleway CLI commands at specific times or intervals without needing to manually execute them.

For step-by-step guides, check out the following tutorials:
- [Power your Instances on and off using Serverless Jobs](/tutorials/power-on-off-instances-jobs/)
- [Create snapshots of a Managed MongoDB® database](/tutorials/backup-mongodb-jobs/)
- [Create recurring scheduled backups and snapshots of a database](/tutorials/snapshot-managed-databases/)
- [Create snapshots of an Instance](/tutorials/snapshot-instances-jobs/)

Refer to the [dedicated documentation](/scaleway-cli/how-to/automate-resources-management/) for more information.