Commands

HausKeeper supports (slash) commands through GitHub issues. To execute a command, simply create an issue inside a repository and write the command prompt in the header.

Command Structure

Commands must follow a specific syntax to be recognized:

/<action> <argument>

Syntax Rules:

• Action and Argument Requirements:
  • Only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-) are allowed
  • Any other characters will be replaced by an _
• Separator: Actions and arguments must be separated by exactly one whitespace

Example Command:

• Command: /create-ruleset branch-protection
• What It Does: Adds the branch protection ruleset to the repository where the command is issued

Available Commands

Command	Argument	Description
/create-ruleset	<ruleset-name>	Adds the ruleset named <ruleset-name> to the repository. You can find a list with all rulesets here. Will add a predefined set of rulesets if no argument given.
/update-rulesets	-	Updates all rulesets in the repository to current standard.
/add-gh-templates	-	Opens a PR to add or update the current GitHub Template files.

Notes

• If the argument is optional, the command will still execute with default behavior
• If no argument is required/allowed it will be ignored
• Ensure that the command is placed in the issue header to be recognized by HausKeeper
• Invalid characters in the action or argument might cause the command to be ignored