rules

Please find below all available sub commands for sifflet rules:

• sifflet rules list: list all existing rules and their ids
• sifflet rules run: trigger one or several rules
• sifflet rules run-history: retrieve the run history of one rule

sifflet rules list

Description

Display rules created on Sifflet.

You can filter with --name to narrow your search.

sifflet rules list
sifflet rules list --name <search_criteria>

Options

--name (string) (optional, default=None)

Filter rules by rule name.

--output (string) (optional, default=table)

Display the result either as a Table or raw Json. Accepted values are table or json.

--page-size (integer) (optional, default=15)

Page size of the server side pagination, the default value is 15. This will be needed in case you have many rules and need to browse the pagination.

--page-num (integer) (optional, default=0)

Page number of the server side pagination, the default value is 0. This will be needed in case you have many rules and need to browse the pagination.

sifflet rules run

Description

Run one or several rules - requires rule id(s).

One the rule is triggered, the shell will wait for the run result. If a rule fail, the program will do an exit 1. If the rules success, the program will do an exit 0.

sifflet rules run --id <rule_id>
sifflet rules run --id <rule_id_1> --id <rule_id_2> --id <rule_id_3>

Options

--id (string)

The rule id to trigger. You can specify multiple id parameters to run multiple rules.

sifflet rules run-history

Description

Display all rule runs for a given rule id.

sifflet rules run-history --id <rule_id>

Options

--id (string) (optional, default=None)

The rule id of the rule to fetch.

--output (string) (optional, default=table)

Display the result either as a Table or raw Json. Accepted values are table or json.

--page-size (integer) (optional, default=15)

Page size of the server side pagination, the default value is 15. This will be needed in case you have many rules and need to browse the pagination.

--page-num (integer) (optional, default=0)

Page number of the server side pagination, the default value is 0. This will be needed in case you have many rules and need to browse the pagination.