You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ibexa_cloud/ibexa_cloud_cli.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,22 @@ ibexa_cloud auth:browser-login
20
20
21
21
## Command reference
22
22
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`.
25
39
26
40
## Examples
27
41
@@ -43,13 +57,13 @@ To execute a SQL upgrade script on a [[= product_name_cloud =]] environment, pas
43
57
44
58
### Connect with a SQL client
45
59
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:
47
61
48
62
```bash
49
63
ibexa_cloud tunnel:open
50
64
```
51
65
52
-
The command outputs connection details, for example:
66
+
The command outputs connection details for each service, for example:
53
67
54
68
```shell-session
55
69
SSH tunnel opened to database at: mysql://user:<PASSWORD>@127.0.0.1:30000/main
0 commit comments