CLI (Command Line Interface)

What is the CLI?

The CLI is the official tool to use and manage your Platform.sh projects directly from your terminal. Anything you can do within the Web Interface can be done with the CLI.

The source code of the CLI is hosted on GitHub.

Detailed information on setting up a local development environment

How do I get it?

You can install the CLI easily using this command:

curl -sS https://platform.sh/cli/installer | php

You can find the system requirements and more information in the installation instructions on GitHub.

What can I do with the CLI?

The CLI uses the platform API to trigger commands (Branch, Merge...) on your Platform.sh project.

It's also very useful when you work locally since it can simulate a local build of your codebase as if you were pushing a change to Platform.sh.

Once you have the CLI installed, run platform list to see all of the available commands.

You can preface any command with help to see more information on how to use that command.

$ platform help domain:add
Command: domain:add
Description: Add a new domain to the project

Usage:
 domain:add [--project[="..."]] [--cert="..."] [--key="..."] [--chain="..."] [name]

Arguments:
 name                  The name of the domain

Options:
 --project             The project ID
 --cert                The path to the certificate file for this domain.
 --key                 The path to the private key file for the provided certificate.
 --chain               The path to the certificate chain file or files for the provided certificate. (multiple values allowed)
 --help (-h)           Display this help message
 --quiet (-q)          Do not output any message
 --verbose (-v|vv|vvv) Increase the verbosity of messages
 --version (-V)        Display this application version
 --yes (-y)            Answer "yes" to all prompts
 --no (-n)             Answer "no" to all prompts
 --shell (-s)          Launch the shell