summaryrefslogtreecommitdiffstats
path: root/docs/part-2/3_xds-cli/3_commands.md
blob: 599906cef3e1bb8d97ff4695406ff48f61e17721 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# Commands

## projects

`projects` (short `prj`) command should be used to managed XDS projects.

This command supports following sub-commands:

```bash
add, a      Add a new project
get         Get a property of a project
list, ls    List existing projects
remove, rm  Remove an existing project
sync        Force synchronization of project sources
```

Here are some usage examples:

```bash
# Create/declare a new project
xds-cli prj add --label "myProjectName" --type pm -p /home/seb/xds-workspace/myProject -sp /home/devel/xds-workspace/myProject

# List projects
xds-cli prj ls

# Delete an existing project
xds-cli prj rm 8e49
```

## sdks

`sdks` (alias `sdk`) command should be used to managed cross SDKs.

This command supports following sub-commands:

```bash
get            Get a property of a SDK
list, ls       List installed SDKs
install, i     Install a SDK
uninstall, rm  UnInstall an existing SDK
abort, a       Abort an install action
```

Here are some usage examples:

```bash
# List existing SDKs
xds-cli sdks ls

# Get SDK info
xds-cli sdks get c64d
```

<!-- section-note -->
**Note:**

Please also refer to [Installing AGL SDKs](../../part-1/3_install-sdks.html) chapter for more details about sdks installation.

<!-- end-section-note -->

## exec

`exec` command should be used to exec command through XDS system.

For example you can use this command to build your project in XDS system.

This command supports following sub-commands:

`exec` command options are:

**`--id` option or `XDS_PROJECT_ID` env variable (**mandatory option**)**

project ID you want to build

**`--rpath` (short `-p`) or `XDS_RPATH` env variable**

relative path into project

**`--sdkid` (alias `--sdk`) or `XDS_SDK_ID` env variable (**mandatory option**)**

Cross Sdk ID to use to build project.

Here are some usage examples:

```bash
cd $MY_PROJECT_DIR
mkdir build

# Generate build system using cmake
xds-cli exec --id=4021 --sdkid=c226 -- "cd build && cmake .."

# Build the project
xds-cli exec --id=4021 --sdkid=c226 -- "cd build && make all"
```

In case of `xds-agent` is not running on default url:port (that is `localhost:8800`)

You can specify the url using `--url` option :

```bash
xds-cli --url=http://localhost:8800 exec --id=4021 --sdkid=c226 -- "cd build && make all"
```

## misc

`misc` command allows to execute miscellaneous sub-commands such as:

```bash
version, v   Get version of XDS agent and XDS server
status, sts  Get XDS configuration status (including XDS server connection)
```

Here are some usage examples:

```bash
xds-cli misc version --verbose

xds-cli misc sts
```