Skip to main content

Dojo CLI commands

The Dojo CLI is a tool to use outside the Dojo ecosystem to execute Dojo models. You can install it anywhere Docker is installed and execute all models registered to Dojo with custom parameters. It's commands are:

CommandDescriptionExample Usage
dojo describePrint a description of the modeldojo describe --model=Population-Model
dojo listmodelsList available modelsdojo listmodels
dojo outputsPrint descriptions of the output and accessory files produced by a modeldojo outputs --model=Topoflow
dojo parametersPrint the parameters required to run a modeldojo parameters --model=CHIRPS-Monthly
dojo resultsGet the results of a model finished running detacheddojo results --name=dojo-mymodel20211225133418
dojo runmodelRun a modeldojo runmodel --model="CHIRPS-Monthly" --params='{"month": "09", "year": "2016", "bounding_box": "[[33.512234, 2.719907], [49.98171,16.501768]]"}'
dojo versionsList all versions of a modeldojo versions --model=CHIRPS-Monthly

Note: Further dojo-cli documentation