Skip to content

Commit c4f661a

Browse files
committed
Review feedback
1 parent 27b242e commit c4f661a

1 file changed

Lines changed: 18 additions & 4 deletions

File tree

docs/ibexa_cloud/ibexa_cloud_cli.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,22 @@ ibexa_cloud auth:browser-login
2020

2121
## Command reference
2222

23-
For the full list of available commands, see the [Upsun CLI reference](https://developer.upsun.com/cli/reference).
24-
Replace `upsun` with `ibexa_cloud` in all examples.
23+
To get started, try the following commands:
24+
25+
- `ibexa_cloud list` lists all available commands
26+
- `ibexa_cloud ssh` opens an SSH session to the current environment, or executes a command remotely
27+
- `ibexa_cloud log` reads an environment's logs
28+
- `ibexa_cloud rel` shows an environment's service relationships
29+
- `ibexa_cloud var` lists environment variables
30+
31+
To get help and see usage examples for any command, run:
32+
33+
```bash
34+
ibexa_cloud <command> --help
35+
```
36+
37+
For the full list of available commands, run `ibexa_cloud list` or see the [Upsun CLI reference](https://developer.upsun.com/cli/reference).
38+
In all examples, replace `upsun` with `ibexa_cloud`.
2539

2640
## Examples
2741

@@ -43,13 +57,13 @@ To execute a SQL upgrade script on a [[= product_name_cloud =]] environment, pas
4357

4458
### Connect with a SQL client
4559

46-
To connect to the database using any SQL client, start a SSH tunnel by running the following command in the project directory:
60+
To connect to the database using any SQL client, start SSH tunnels to all services (database, Redis, Solr, and others with the exception of Varnish) by running the following command in the project directory:
4761

4862
```bash
4963
ibexa_cloud tunnel:open
5064
```
5165

52-
The command outputs connection details, for example:
66+
The command outputs connection details for each service, for example:
5367

5468
``` shell-session
5569
SSH tunnel opened to database at: mysql://user:<PASSWORD>@127.0.0.1:30000/main

0 commit comments

Comments
 (0)