Ibexa Cloud CLI¶
The Ibexa Cloud CLI (ibexa_cloud) is a command-line tool for managing your Ibexa Cloud projects.
It's 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 | |
Command reference¶
To get started, try the following commands:
ibexa_cloud listlists all available commandsibexa_cloud sshopens an SSH session to the current environment, or executes a command remotelyibexa_cloud logreads an environment's logsibexa_cloud relshows an environment's service relationshipsibexa_cloud varlists environment variables
To get help and see usage examples for any command, run:
1 | |
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 SQL script¶
To execute an SQL upgrade script on a Ibexa Cloud environment, pass it to ibexa_cloud sql:
1 | |
1 | |
Run database migration¶
To apply Ibexa Doctrine migrations on a Ibexa Cloud environment, connect with SSH:
1 | |
You can preview the changes before you apply them:
1 | |
Preview only
This generates an SQL file that is only intended for review. More recent migrations can be unaware of changes made by earlier migrations in the same run, so the file may be incomplete. Do not run the SQL file against your database.
Always apply changes by running the command without the --dry-run flag.
Then apply the migrations:
1 | |
Connect with 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 | |
The command outputs connection details for each service, for example:
1 | |
Use the displayed host, port, database name, username, and password to configure your SQL client.
When you're done, close the tunnels:
1 | |