From 990ecd15ca4636c3972726c07a603b409684ecae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Thu, 14 May 2026 11:12:01 +0200 Subject: [PATCH 1/3] Added dedicated page for Ibexa Cloud CLI --- docs/ibexa_cloud/ddev_and_ibexa_cloud.md | 1 + docs/ibexa_cloud/ibexa_cloud.md | 1 + docs/ibexa_cloud/ibexa_cloud_cli.md | 64 ++++++++++++++++++++++ docs/ibexa_cloud/install_on_ibexa_cloud.md | 7 +-- mkdocs.yml | 1 + 5 files changed, 68 insertions(+), 6 deletions(-) create mode 100644 docs/ibexa_cloud/ibexa_cloud_cli.md diff --git a/docs/ibexa_cloud/ddev_and_ibexa_cloud.md b/docs/ibexa_cloud/ddev_and_ibexa_cloud.md index 907b1cc0ee..57c60a902a 100644 --- a/docs/ibexa_cloud/ddev_and_ibexa_cloud.md +++ b/docs/ibexa_cloud/ddev_and_ibexa_cloud.md @@ -13,6 +13,7 @@ Two ways are available to run an [[= product_name_cloud =]] project locally with !!! note The following examples use [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.co/). + For more information and examples, see [[[= product_name_cloud =]] CLI](ibexa_cloud_cli.md). ## With Ibexa Cloud add-ons diff --git a/docs/ibexa_cloud/ibexa_cloud.md b/docs/ibexa_cloud/ibexa_cloud.md index 03bd6652cc..f285dbc618 100644 --- a/docs/ibexa_cloud/ibexa_cloud.md +++ b/docs/ibexa_cloud/ibexa_cloud.md @@ -11,6 +11,7 @@ month_change: false [[= cards([ "ibexa_cloud/ibexa_cloud_guide", "ibexa_cloud/install_on_ibexa_cloud", + "ibexa_cloud/ibexa_cloud_cli", "ibexa_cloud/environment_variables", "ibexa_cloud/ddev_and_ibexa_cloud", ], columns=3) =]] diff --git a/docs/ibexa_cloud/ibexa_cloud_cli.md b/docs/ibexa_cloud/ibexa_cloud_cli.md new file mode 100644 index 0000000000..c32bb968d9 --- /dev/null +++ b/docs/ibexa_cloud/ibexa_cloud_cli.md @@ -0,0 +1,64 @@ +--- +description: Use the Ibexa Cloud CLI to manage your Ibexa Cloud projects from the command line. +month_change: true +--- + +# [[= product_name_cloud =]] CLI + +The [[= product_name_cloud =]] CLI (`ibexa_cloud`) is a command-line tool for managing your [[= product_name_cloud =]] projects. +It is based on the [Upsun CLI](https://docs.upsun.com/administration/cli.html) and shares the same commands. + +## Installation + +Follow the installation instructions at [cli.ibexa.cloud](https://cli.ibexa.cloud/). + +After installation, authenticate with your [[= product_name_cloud =]] account: + +```bash +ibexa_cloud auth:browser-login +``` + +## Command reference + +For the full list of available commands, see the [Upsun CLI reference](https://developer.upsun.com/cli/reference). +Replace `upsun` with `ibexa_cloud` in all examples. + +## Examples + +### Run a SQL script + +To execute a SQL upgrade script on a [[= product_name_cloud =]] environment, pass it to `ibexa_cloud sql`: + +=== "MySQL" + + ```bash + ibexa_cloud sql < vendor/ibexa/installer/upgrade/db/mysql/ibexa-x.x.x-to-x.x.y.sql + ``` + +=== "PostgreSQL" + + ```bash + 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 a graphical SQL client, start a SSH tunnel by running the following command in the project directory: + +```bash +ibexa_cloud tunnel:open +``` + +The command outputs connection details, for example: + +``` +SSH tunnel opened to database at: mysql://user:@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: + +```bash +ibexa_cloud tunnel:close +``` diff --git a/docs/ibexa_cloud/install_on_ibexa_cloud.md b/docs/ibexa_cloud/install_on_ibexa_cloud.md index edc0907cd1..c4265dc01a 100644 --- a/docs/ibexa_cloud/install_on_ibexa_cloud.md +++ b/docs/ibexa_cloud/install_on_ibexa_cloud.md @@ -113,9 +113,4 @@ Modify this password after the installation, for example, by using [data migrati Don't use Upsun CLI (`upsun`), instead, use the [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.cloud/). - To install [[= product_name_cloud =]] CLI, follow https://cli.ibexa.cloud/ "Installation instructions". - - [[= product_name_cloud =]] CLI and Upsun CLI share the same commands and the [same documentation](https://fixed.docs.upsun.com/administration/cli.html#3-use), but you have to replace `upsun` with `ibexa_cloud`. - - If you have previously set up an alias to use Upsun CLI with [[= product_name_cloud =]], it's outdated. - Remove the alias and install [[= product_name_cloud =]] CLI instead. + For more information, see [[[= product_name_cloud =]] CLI](ibexa_cloud_cli.md). diff --git a/mkdocs.yml b/mkdocs.yml index ca8e299822..55d7c99513 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -853,6 +853,7 @@ nav: - Ibexa Cloud: ibexa_cloud/ibexa_cloud.md - Ibexa Cloud guide: ibexa_cloud/ibexa_cloud_guide.md - Install on Ibexa Cloud: ibexa_cloud/install_on_ibexa_cloud.md + - Ibexa Cloud CLI: ibexa_cloud/ibexa_cloud_cli.md - Environment variables: ibexa_cloud/environment_variables.md - DDEV and Ibexa Cloud: ibexa_cloud/ddev_and_ibexa_cloud.md - Infrastructure and maintenance: From 33a25c92ae84c25e7a67b2da74b47ce22dac7617 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Thu, 14 May 2026 16:10:24 +0200 Subject: [PATCH 2/3] Selfreview --- docs/ibexa_cloud/ibexa_cloud_cli.md | 4 ++-- docs/ibexa_cloud/install_on_ibexa_cloud.md | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/ibexa_cloud/ibexa_cloud_cli.md b/docs/ibexa_cloud/ibexa_cloud_cli.md index c32bb968d9..10ae65fab9 100644 --- a/docs/ibexa_cloud/ibexa_cloud_cli.md +++ b/docs/ibexa_cloud/ibexa_cloud_cli.md @@ -1,5 +1,5 @@ --- -description: Use the Ibexa Cloud CLI to manage your Ibexa Cloud projects from the command line. +description: Use the [[= product_name_cloud =]] CLI to manage your I[[= product_name_cloud =]] projects from the command line. month_change: true --- @@ -51,7 +51,7 @@ ibexa_cloud tunnel:open The command outputs connection details, for example: -``` +``` shell-session SSH tunnel opened to database at: mysql://user:@127.0.0.1:30000/main ``` diff --git a/docs/ibexa_cloud/install_on_ibexa_cloud.md b/docs/ibexa_cloud/install_on_ibexa_cloud.md index c4265dc01a..b1e40cc05e 100644 --- a/docs/ibexa_cloud/install_on_ibexa_cloud.md +++ b/docs/ibexa_cloud/install_on_ibexa_cloud.md @@ -1,5 +1,5 @@ --- -description: Install and configure Ibexa DXP to run in cloud using Ibexa Cloud. +description: Install and configure Ibexa DXP to run in cloud using [[= product_name_cloud =]]. month_change: false --- @@ -82,6 +82,8 @@ In **Settings** (top right gear icon) -> **Project Settings** -> **Variables** - ### Composer authentication using the CLI command +Use [Ibexa Cloud CLI](ibexa_cloud_cli.md) to create the variable: + ```bash ibexa_cloud variable:create --level project --name env:COMPOSER_AUTH \ --json true --visible-runtime false --sensitive true --visible-build true \ @@ -111,6 +113,6 @@ Modify this password after the installation, for example, by using [data migrati !!! caution - Don't use Upsun CLI (`upsun`), instead, use the [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.cloud/). + Don't use Upsun CLI (`upsun`), instead, use the [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.cloud/) instead. For more information, see [[[= product_name_cloud =]] CLI](ibexa_cloud_cli.md). From 27b242ec488d939f9a8b63a714b992fcc75f75aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Fri, 15 May 2026 08:40:48 +0200 Subject: [PATCH 3/3] Wording --- docs/ibexa_cloud/ibexa_cloud_cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ibexa_cloud/ibexa_cloud_cli.md b/docs/ibexa_cloud/ibexa_cloud_cli.md index 10ae65fab9..c61de39eaf 100644 --- a/docs/ibexa_cloud/ibexa_cloud_cli.md +++ b/docs/ibexa_cloud/ibexa_cloud_cli.md @@ -43,7 +43,7 @@ To execute a SQL upgrade script on a [[= product_name_cloud =]] environment, pas ### Connect with a SQL client -To connect to the database using a graphical SQL client, start a SSH tunnel by running the following command in the project directory: +To connect to the database using any SQL client, start a SSH tunnel by running the following command in the project directory: ```bash ibexa_cloud tunnel:open