syntribos/doc/source/commands.rst

1.1 KiB

Commands

Below are the set of commands that can be specified while using syntribos.

  • syntribos run

    This command runs syntribos with the given config options

    $ syntribos --config-file keystone.conf -t SQL run
  • syntribos dry-run

    This command ensures that the template files given for this run parse successfully without errors. It then runs a debug test which sends no requests of its own.

    Note: If any external calls referenced inside the template file do make requests, the parser will still make those requests even for a dry run.

    $ syntribos --config-file keystone.conf dry_run
  • syntribos list_tests

    This command will list the names and description of all the tests that can be executed by the run command.

    $ syntribos --config-file keystone.conf list_tests

All these commands will only work if a configuration file is specified. If a configuration file is present in the default path ( .syntribos/syntribos.conf ), then you do not need to explicitly specify a config file and can just run syntribos like syntribos run.