Efficiently manage & deploy your infrastructure with the Command Line Interface tool
Scaleway CLI is a tool to help you pilot your Scaleway infrastructure directly from your terminal. We provide static-compiled binaries for darwin (macOS), GNU/Linux, and Windows platforms. Actions are organized around a set of verbs such as
update that can be used with a wide variety of products.
After you have installed the latest release you can run the initialization command,
scw init. It will set up your profile and the authentication. You can either choose to log with a valid secret-key or with your credentials (email, password and 2FA code). By default your credentials will be stored in the HOME/.config/scw/config.yaml on UNIX platform and in your USERPROFILE in Windows.
With the CLI v2 we offer support for a wide range of actions on all resources present and coming in the Scaleway Elements ecosystem. Currently, the following resources are available:
Account resources, Baremetal, Instances (including Block Storage volumes, flexible IP adresses, Placement Groups, Security Groups, etc…), Kubernetes Kapsule, Object Storage, Database and Container Registry.
To ease the use of the Scaleway CLI, you can use the auto-completion feature. We have a common syntax across all our products: namespace, resource and verb. As an example with the following command:
scw instance server list.
instance: Refers to the product namespace
server: Refers to a resource maintained in the product namespace
list: Refers to a verb applied to the currently selected API
Scaleway CLI is hosted on Github and is mainly maintained by our engineers. This tool is written in Go and, since the v2 version, is generated from our API Gateway, feel free to contribute to it or to request the development of a new feature. Do not hesitate to open a Github issue or to reach us on Scaleway Slack community. We would appreciate your feedback.
We ensure your services are always up and running. Our technical assistance is available 24 hours a day, 7 days a week to answer all your questions and to assist you. Simply open a new ticket in case of a problem. You can also reach our support directly by phone or to get faster responses if you upgrade your support plan.
Manage your infrastructure without leaving your terminal
Popular use cases with our Command Line Interface tool
A CI/CD pipeline is often triggered by a change in code (like a post-commit hook in git). It can help to merge the change and then deploy your code.
To automatically provision new resources when changes occur and have been validated, you can write custom scripts that will launch Scaleway CLI commands.
It can be hard to keep all your resources up-to-date, especially if you have a lot of them. The Scaleway Command Line Interface tool let you easily perform updates on a large volume of resources. As an example, you can use the following command:
scw instance server update.
As your business grows, you need more resources to succeed. A popular use case with multi-instance SaaS architectures is to provision all the required components when a new client is won. For this, you may want to spend some times writing a script that automatically create your client’s dedicated instances and volumes with your software running on theses resources.
Discover our compute resources available with the CLI
This product is open source
You have a project? Contact us:
The CLI got a bootstrapping command called init. Just type
scw init to get started. Once your credentials are set up, go to the README and through the documentation to find all our features:
You can find a complete migration guide directly on Github: https://github.com/scaleway/scaleway-cli/blob/master/docs/migration_guide_v2.md
By default we store everything in the HOME/.config/scw/config.yaml on UNIX platform and in your USERPROFILE in Windows
None! The CLI is released as a single binary you run directly on your machine. The code source is available at https://github.com/scaleway/scaleway-cli
You can do it with the CLI itself!
scw feedback feature or
scw feedback bug will open a Github issue for you.
Feel free to join the Slack of the Scaleway Community. We are hanging out on the #cli channel.