Skip to main content
Version: 3.2.0

CLI

Starting with version 3.2, Runnerty incorporates the tools previously offered in runnerty-cli.

Options#

OptionArgumentDefaultDescription
-h, --helpdisplay help for command
-v, -V, --versionreturns Runnerty version

Commands#

CommandArgumentDescription
runoptionsrun a project. Default command
new, noptions projectNamecreate a new project
add, aoptions moduleadd runnerty module
migrate-cron, mcprojectName crontabPathmigrate crontab to new runnerty project
help[command]display help for command
TIP

If no command is indicated, the run command will be executed, this makes version 3.2 compatible with previous versions.

Run options#

OptionArgumentDefaultDescription
-h, --helphelp output usage information
-c, --configpath./config.jsonOverwrite path file config
-p, -P, --planpath./plan.jsonOverwrite path file plan of config file
-f, --force_chain_execchainIdForce chain execution (For development tests). It is possible to set a list of comma separated items
-fp, --force_processproccessIdForce process execution. You must also indicate the chain_id. For development tests).
-fd, --force_chain_dependentsIt should be indicated in case you want the chains that depend on the forced chains to be executed (For development tests).
-fpd, --force_process_dependents It should be indicated in case you want the processes that depend on the forced processes to be executed (For development tests).
--input_valuesinputValuesInput values for force chain execution (-f) (For development tests): --input_values '[{"iter1V1":"A","iter1V2":"B"},{"iter21":"1",...]'
--endEnd runnerty on force chain execution (-f) (For development tests).
--custom_valuescustomValuesCustom values for force chain execution (-f) (For development tests): --custom_values '{"customValue_1":"v1",...}'
--config_userconfigUserUser for remote (url) config file (Basic Auth User)
--config_passwordconfigPasswordPassword for remote (url) config file (Basic Auth Password)
-n, --namespacenamespaceEnable the chains of the indicated namespace. It is possible to set a list of comma separated items
-en, --exclude_namespacenamespaceDisable the chains of the indicated namespace. It is possible to set a list of comma separated items
-h, --helpdisplay help for command

Samples#

runnerty -c /etc/runnerty/config.json -p /user/workdir/other_plan.json -f CHAIN_ONE --custom_values {\"YYYY\":\"1986\"} --end
runnerty -c /etc/runnerty/config.json -p /user/workdir/other_plan.json -f CHAIN_ONE -fd --custom_values '{"YYYY":"1986"}' --end
runnerty -c /etc/runnerty/config.json -p /user/workdir/other_plan.json -f CHAIN_ONE --custom_values '{"YYYY":"1986"}' --input_values '[{"KEY_1":"1-1", "KEY_2":"1-2"},{"KEY_1":"2-1", "KEY_2":"2-2"}]' --end
runnerty -f CHAIN_ONE -fd --end
runnerty -f CHAIN_ONE -fd -fp PROCESS_ONE -fpd --end

TODO: ADD FPD AND FP SAMPLES

New options#

OptionDescription
-h, --helphelp output usage information
-sg, --skip_gitdo not initialize a git repository

Samples#

runnerty new my_runnerty_project
runnerty new my_runnerty_project -sg

Add options#

OptionArgumentDescription
-h, --helphelp output usage information
-c, --configconfigPathset config.json path to add module.
-p, --packagepackagePathset package.json path to add module.
-ws, --without_scaffoldpackagePathdo not include scaffolding in add module.

Samples#

runnerty add @runnerty/executor-shell
runnerty add own_excutor -ws

Migrate crontab#

OptionDescription
-h, --helphelp output usage information

Samples#

runnerty migrate-cron my_runnerty_migrated_project
runnerty mc my_runnerty_migrated_project /usr/lib/cron/tabs/my_user