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: doc/source/guide/gui-tool-usage.md
+24-10Lines changed: 24 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,23 +7,37 @@ uid: SmartSetup.GUIToolUsage
7
7
8
8
Alternatively to command-line, you can use the GUI tool. Just launch `tmsgui.exe` executable.
9
9
10
-
If the working folder is not initialized, it will first ask for credentials to download products from repository. If you skip this step, no credentials will be saved and you can continue using the GUI to build projects that have been manually downloaded:
10
+
If the working folder is not initialized, it will first ask you what servers you want to enable:
11
+
12
+
{{#image}}tmsgui-welcome-dialog.png{{/image}}
13
+
14
+
Here, you can choose if you want to manage **tms** products, if you want manage products from the **community** server, or both.
15
+
16
+
If you enable the tms server, you will get another dialog asking you for the credentials:
11
17
12
18
{{#image}}tmsgui-login.png{{/image}}
13
19
14
-
The GUI tool lists the installed and available products in the main listing view.
20
+
And then you should arrive to the main view:
15
21
16
22
{{#image}}tmsgui-main-screen.png{{/image}}
17
23
18
-
At the right, you have some buttons that perform on the selected products:
24
+
1.**Search box**: type to find the product you want to install
25
+
2.**Filter pane**: select if to see all available products, or only installed ones.
26
+
3.**Product list**: a list of all products installed or available
27
+
4.**Server selection box** this box is only visible if there is more than one active server, and it allows to filter the results by server
28
+
5.**Settings**: Set general settings for tms/tmsgui
29
+
6.**Install**: download and install the selected products. Equivalent to `tms install` command.
30
+
7.**Uninstall**: uninstall the selected products. Equivalent to `tms uninstall` command.
31
+
8.**Full build/Partial build**: rebuild the selected products. If no products are selected, rebuild everything. Equivalent to `tms build -full` and `tms build` commands
32
+
9.**Credentials**: ask for new credentials. Equivalent to `tms credentials` command.
33
+
10.**Configure**: create (if missing) and open the YAML configuration file. Equivalent to `tms config` command.
34
+
11.**Output tab**: shows the output of the current command-line being executed. For long-running commands like installing and building, you can switch to it to follow the progress of the execution.
35
+
12.**Status bar**: at the bottom of the main window, the GUI displays the current working folder, and the current Smart Setup version.
36
+
37
+
When there are errors, an error pane will show:
19
38
20
-
-**Install**: download and install the selected products. Equivalent to `tms install` command.
21
-
-**Uninstall**: uninstall the selected products. Equivalent to `tms uninstall` command.
22
-
-**Full build/Partial build**: rebuild the selected products. If no products are selected, rebuild everything. Equivalent to `tms build -full` and `tms build` commands
23
-
-**Configure**: create (if missing) and open the YAML configuration file. Equivalent to `tms config` command.
24
-
-**Credentials**: ask for new credentials. Equivalent to `tms credentials` command.
39
+
{{#image}}tmsgui-errors.png{{/image}}
25
40
26
-
In the status bar, at the bottom of the main window, the GUI displays the current working folder, and the current Smart Setup version.
41
+
If you click on the messages of the error pane, it will show more detailed information about the particular error.
27
42
28
-
Under the hood, the GUI just executes the `tms` command-line. The `Output` tab shows the output of the current command-line being executed. For long-running commands like installing and building, you can switch to it to follow the progress of the execution.
0 commit comments