docs/ATTIC/3_Developer_Guides/4_X(cross)_Development_System:_User's_Guide/4_X(cross)_Development_System:_ Internals /3.4.4.4_xds-cli/3.4.4.4.3_Commands.md

   1 <!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/xds-docs-guides-devguides-book.yml -->
   2
   3 # Commands
   4
   5 ## projects
   6
   7 `projects` (short `prj`) command should be used to managed XDS projects.
   8
   9 This command supports following sub-commands:
  10
  11 ```bash
  12 add, a      Add a new project
  13 get         Get a property of a project
  14 list, ls    List existing projects
  15 remove, rm  Remove an existing project
  16 sync        Force synchronization of project sources
  17 ```
  18
  19 Here are some usage examples:
  20
  21 ```bash
  22 # Create/declare a new project
  23 xds-cli prj add --label "myProjectName" --type pm -p /home/seb/xds-workspace/myProject -sp /home/devel/xds-workspace/myProject
  24
  25 # List projects
  26 xds-cli prj ls
  27
  28 # Delete an existing project
  29 xds-cli prj rm 8e49
  30 ```
  31
  32 ## sdks
  33
  34 `sdks` (alias `sdk`) command should be used to managed cross SDKs.
  35
  36 This command supports following sub-commands:
  37
  38 ```bash
  39 get            Get a property of a SDK
  40 list, ls       List installed SDKs
  41 install, i     Install a SDK
  42 uninstall, rm  UnInstall an existing SDK
  43 abort, a       Abort an install action
  44 ```
  45
  46 Here are some usage examples:
  47
  48 ```bash
  49 # List existing SDKs
  50 xds-cli sdks ls
  51
  52 # Get SDK info
  53 xds-cli sdks get c64d
  54 ```
  55
  56 <!-- section-note -->
  57 **Note:**
  58
  59 Refer to the
  60 "[AGL SDKs](../../part-1/install-sdk.html)"
  61 topic for details about SDK installation.
  62
  63 <!-- end-section-note -->
  64
  65 ## exec
  66
  67 `exec` command should be used to exec command through XDS system.
  68
  69 For example you can use this command to build your project in XDS system.
  70
  71 This command supports following sub-commands:
  72
  73 `exec` command options are:
  74
  75 **`--id` option or `XDS_PROJECT_ID` env variable (**mandatory option**)**
  76
  77 project ID you want to build
  78
  79 **`--rpath` (short `-p`) or `XDS_RPATH` env variable**
  80
  81 relative path into project
  82
  83 **`--sdkid` (alias `--sdk`) or `XDS_SDK_ID` env variable (**mandatory option**)**
  84
  85 Cross Sdk ID to use to build project.
  86
  87 Here are some usage examples:
  88
  89 ```bash
  90 cd $MY_PROJECT_DIR
  91 mkdir build
  92
  93 # Generate build system using cmake
  94 xds-cli exec --id=4021 --sdkid=c226 -- "cd build && cmake .."
  95
  96 # Build the project
  97 xds-cli exec --id=4021 --sdkid=c226 -- "cd build && make all"
  98 ```
  99
 100 In case of `xds-agent` is not running on default url:port (that is `localhost:8800`)
 101
 102 You can specify the url using `--url` option :
 103
 104 ```bash
 105 xds-cli --url=http://localhost:8800 exec --id=4021 --sdkid=c226 -- "cd build && make all"
 106 ```
 107
 108 ## misc
 109
 110 `misc` command allows to execute miscellaneous sub-commands such as:
 111
 112 ```bash
 113 version, v   Get version of XDS agent and XDS server
 114 status, sts  Get XDS configuration status (including XDS server connection)
 115 ```
 116
 117 Here are some usage examples:
 118
 119 ```bash
 120 xds-cli misc version --verbose
 121
 122 xds-cli misc sts
 123 ```