-
Notifications
You must be signed in to change notification settings - Fork 81
Added dedicated page for Ibexa Cloud CLI #3198
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 5.0
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| description: Use the [[= product_name_cloud =]] CLI to manage your I[[= product_name_cloud =]] projects from the command line. | ||
|
Check failure on line 2 in docs/ibexa_cloud/ibexa_cloud_cli.md
|
||
| month_change: true | ||
| --- | ||
|
|
||
| # [[= product_name_cloud =]] CLI | ||
|
Check notice on line 6 in docs/ibexa_cloud/ibexa_cloud_cli.md
|
||
|
|
||
| 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. | ||
|
Check notice on line 9 in docs/ibexa_cloud/ibexa_cloud_cli.md
|
||
|
|
||
| ## 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 | ||
|
Check notice on line 28 in docs/ibexa_cloud/ibexa_cloud_cli.md
|
||
|
|
||
| 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 | ||
|
Check notice on line 44 in docs/ibexa_cloud/ibexa_cloud_cli.md
|
||
|
|
||
| To connect to the database using any SQL client, start a SSH tunnel by running the following command in the project directory: | ||
|
Check notice on line 46 in docs/ibexa_cloud/ibexa_cloud_cli.md
|
||
|
|
||
| ```bash | ||
| ibexa_cloud tunnel:open | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just so we are clear.. This will open a ssh tunnel to all services (db, redis, solr etc), not only to the DB. Only execption I know how is varnish if you have that.. No tunnel to varnish will be estabilished |
||
| ``` | ||
|
|
||
| The command outputs connection details, for example: | ||
|
|
||
| ``` shell-session | ||
| 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: | ||
|
|
||
| ```bash | ||
| ibexa_cloud tunnel:close | ||
| ``` | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.