To generate a ready to run ruleset for vacuum, use the generate-ruleset command.

There are five options available:

  • recommended - This will generate a ruleset based on the recommended rules.
  • all - This will generate a ruleset based on all available rules.
  • owasp - This will generate a ruleset based on the OWASP rules.
  • asyncapi-recommended - This will generate a ruleset based on the recommended AsyncAPI rules.
  • asyncapi-all - This will generate a ruleset based on all available AsyncAPI rules.
vacuum generate-ruleset recommended

Will print out something like this:

RuleSet generated for 'recommended', written to 'ruleset-recommended.yaml'

Generate AsyncAPI rulesets the same way.

vacuum generate-ruleset asyncapi-recommended my-asyncapi-rules 
RuleSet generated for 'asyncapi-recommended', written to 'my-asyncapi-rules-asyncapi-recommended.yaml'