summaryrefslogtreecommitdiffstats
path: root/docs/part-2/3_xds-cli/2_commands.md
diff options
context:
space:
mode:
authorJohann CAHIER <johann.cahier@iot.bzh>2018-10-09 10:45:08 +0200
committerJohann CAHIER <johann.cahier@iot.bzh>2018-10-11 13:38:39 +0200
commitbbbe9c168526bbb729022f9de903aff5690b328d (patch)
treee20b465e03d23d4c85a62dbfbc2aa1d8f8c13a4f /docs/part-2/3_xds-cli/2_commands.md
parent48374d29bcc3bcf2b055b49d56eac49247772271 (diff)
Improves documentation
* Describes better available source tree sharing method (between xds-agent and xds-server), and which to prefer depending on the deployment setup. * Gives indication about how to pass RSYNC_TARGET and RSYNC_PREFIX env vars to the helloworld-native-application build process. * Swap chapter order (build before config) Change-Id: Ie4c22f277a59b0405744d71b0fadff67c5d5d025 Signed-off-by: Johann CAHIER <johann.cahier@iot.bzh>
Diffstat (limited to 'docs/part-2/3_xds-cli/2_commands.md')
-rw-r--r--docs/part-2/3_xds-cli/2_commands.md119
1 files changed, 0 insertions, 119 deletions
diff --git a/docs/part-2/3_xds-cli/2_commands.md b/docs/part-2/3_xds-cli/2_commands.md
deleted file mode 100644
index 599906c..0000000
--- a/docs/part-2/3_xds-cli/2_commands.md
+++ /dev/null
@@ -1,119 +0,0 @@
-# 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
-```