Skip to content

Added dedicated page for Ibexa Cloud CLI#3198

Open
mnocon wants to merge 3 commits into
5.0from
ibexa_cloud_db
Open

Added dedicated page for Ibexa Cloud CLI#3198
mnocon wants to merge 3 commits into
5.0from
ibexa_cloud_db

Conversation

@mnocon
Copy link
Copy Markdown
Contributor

@mnocon mnocon commented May 14, 2026

Contains the suggestions from Slack

@github-actions
Copy link
Copy Markdown

@mnocon mnocon marked this pull request as ready for review May 14, 2026 14:12
@mnocon mnocon requested review from alongosz, reithor and vidarl May 14, 2026 14:12
Comment thread docs/ibexa_cloud/ibexa_cloud_cli.md Outdated

### 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:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"local SQL client", or "any SQL client", or just "SQL client". Doesn't need to be graphical ;)

Copy link
Copy Markdown
Contributor Author

@mnocon mnocon May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 27b242e , thanks 😄

@sonarqubecloud
Copy link
Copy Markdown

@mnocon mnocon requested a review from alongosz May 15, 2026 11:31
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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The 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.
Maybe that should be pointed out?

Only execption I know how is varnish if you have that.. No tunnel to varnish will be estabilished

Copy link
Copy Markdown
Contributor

@reithor reithor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

additional notes:
Personally I very often use:

ibexa_cloud list
   list  Lists commands
ibexa_cloud ssh
   environment:ssh (ssh)  : SSH to the current environment 
   (or execute a command)

Honorable mentions:

ibexa_cloud log
   environment:logs (log)  : Read an environment's logs

ibexa_cloud rel
   environment:relationships (relationships, rel)  :  Show an environment's relationships

ibexa_cloud var
   variable:list (variables, var)  : List variables

Killer helpful thing (might be obvious though):

ibexa_cloud [command] --help
   shows help and provides examples


## Command reference

For the full list of available commands, see the [Upsun CLI reference](https://developer.upsun.com/cli/reference).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For the full list of available commands, see the [Upsun CLI reference](https://developer.upsun.com/cli/reference).
For the full list of available commands, run `ibexa_cloud list` or see the [Upsun CLI reference](https://developer.upsun.com/cli/reference).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants