Skip to content

Ibexa Cloud CLI

The Ibexa Cloud CLI (ibexa_cloud) is a command-line tool for managing your Ibexa Cloud projects. It is based on the Upsun CLI and shares the same commands.

Installation

Follow the installation instructions at cli.ibexa.cloud.

After installation, authenticate with your Ibexa Cloud account:

1
ibexa_cloud auth:browser-login

Command reference

For the full list of available commands, see the Upsun CLI reference. Replace upsun with ibexa_cloud in all examples.

Examples

Run a SQL script

To execute a SQL upgrade script on a Ibexa Cloud environment, pass it to ibexa_cloud sql:

1
ibexa_cloud sql < vendor/ibexa/installer/upgrade/db/mysql/ibexa-x.x.x-to-x.x.y.sql
1
ibexa_cloud sql < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-x.x.x-to-x.x.y.sql

Connect with a SQL client

To connect to the database using any SQL client, start a SSH tunnel by running the following command in the project directory:

1
ibexa_cloud tunnel:open

The command outputs connection details, for example:

1
SSH tunnel opened to database at: mysql://user:<PASSWORD>@127.0.0.1:30000/main

Use the displayed host, port, database name, username, and password to configure your SQL client.

When you're done, close the tunnel:

1
ibexa_cloud tunnel:close