Vorto CLI Tool Command Summary

The Vorto CLI Tool provides a scope of different Vorto Commands to interact with your specified Repository. Each of them offers a unique functionality and is based on the following syntax:

vorto [command] [-flag1 parameter1 -flag2 parameter2 ... ]
</tr> </tbody> </table>

Command Description Example
vorto config With the vorto config command you do the basic CLI Tool setup.
Additional flag parameters:
  • username
    Vorto Repository username credentials
  • password
    Vorto Repository password credentials
  • proxy
    network proxy
  • repo
    Vorto repository URL (default: http://vorto.eclipse.org)
For (Windows/Mac/Linux),

vorto config -username vortouser -password password -repo http://vorto.eclipse.org

vorto help To get more familiar with the CLI Tool commands, it's a good approach to call the vorto help command.
vorto help lists you all other possible commands, including flag parameters and examples.
For (Windows/Mac/Linux),

vorto help</b> </td> </tr>

vorto query After everything is successfully setup, you are able to access the Repository.
Via vorto query you can query models of your Repository.
For (Windows/Mac/Linux),

Query all models of your Repository:
vorto query "*"

Query all models containing the string "functionblocks":
vorto query "*functionblocks*"
vorto info If you are now interested in a certain model and you want to get more information from this specific model, you can use vorto info to get it.
The result of this command is a detailed view of the requested model.
For (Windows/Mac/Linux),
vorto info examples.informationmodels.TI_SensorTag:1.0.0
vorto download Furthermore you can start working with a certain model locally, when you download it via vorto download.
To open and to work with it, you can use any text editor to modify this certain model and you can even upload it again.
Via the flag -outputPath you can specify a download directory.
Additional flag parameters:
  • output
    output format (default: DSL)
  • outputPath
    path to store the download (default: current directory)
  • includeDependencies
    whether to include dependencies or not (default: false)
For Windows,
vorto download examples.informationmodels.TI_SensorTag:1.0.0 -outputPath D:\models

For Mac/Linux,
vorto download examples.informationmodels.TI_SensorTag:1.0.0 -outputPath /Users/{$username}/Documents/models/
vorto generators If you want to generate platform specific code, you can get a short overview of all active code generators via vorto generators. For (Windows/Mac/Linux),
vorto generators
vorto generate Afterwards you can generate vorto generate your platform specific code (specified by -generatorKey) in a very convenient way.
Additional flag parameters:
  • generatorKey
  • outputPath
For Windows,
vorto generate examples.informationmodels.TI_SensorTag:1.0.0 -generatorKey mqtt -outputPath D:\models

For Mac/Linux,
vorto generate examples.informationmodels.TI_SensorTag:1.0.0 -generatorKey mqtt -outputPath /Users/{$username}/Documents/models
vorto share</td> Additionally to all this access functionality, you are also able to share your models.
Therefore you either have to deposit your credentials in the .vortocli.yaml file or you have to pass them as additional parameters.
Additional flag parameters:
  • username
    Vorto Repository username credentials (default: value in .vortocli.yaml)
  • password
    Vorto Repository password credentials (default: value in .vortocli.yaml)
For Windows,
vorto share D:\Models\TI_SensorTag_CC2650\src\models\TI_SensorTag.infomodel
vorto share D:\Models\TI_SensorTag_CC2650\src\models\TI_SensorTag.infomodel -username vortouser -password password

For Mac/Linux,
vorto share /Users/{$username}/Documents/models/TI_SensorTag.infomodel

vorto share /Users/{$username}/Documents/models/TI_SensorTag.infomodel -username vortouser -password password