Skip to content
  • Documentation >
  • Ibexa Cloud >
  • Ibexa Cloud CLI

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

To get started, try the following commands:

  • ibexa_cloud list lists all available commands
  • ibexa_cloud ssh opens an SSH session to the current environment, or executes a command remotely
  • ibexa_cloud log reads an environment's logs
  • ibexa_cloud rel shows an environment's service relationships
  • ibexa_cloud var lists environment variables

To get help and see usage examples for any command, run:

1
ibexa_cloud <command> --help

For the full list of available commands, run ibexa_cloud list or see the Upsun CLI reference. In all examples, replace upsun with ibexa_cloud.

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 SSH tunnels to all services (database, Redis, Solr, and others except Varnish) by running the following command in the project directory:

1
ibexa_cloud tunnel:open

The command outputs connection details for each service, 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 tunnels:

1
ibexa_cloud tunnel:close