Commands

This is a list of the current commands that zulipbot supports.

• Only one command can be used per comment/description.
• Comments edited to be included in a comment/description will not work.
• Commands within code blocks will be ignored and any commands that follow in the same comment/description will not work.

Format

@username command "multiple" "arguments"

• username — The username object configured in src/secrets.js; the username that zulipbot is authenticated as.
• command — The specified command that will trigger a response or action from zulipbot.
• "multiple" "arguments" — The arguments for commands are surrounded with double quotes ("); only certain commands require arguments.

Commands

@username claim

Assigns the commenter to an issue (or issue creator if included in an issue body). Works in issue comments and issue descriptions.

• Gives new contributors repository permissions based on the addCollabPermission object
• If inProgressLabel is defined in src/config.js, a label with the value of inProgressLabel will be added to the claimed issue.
• Can be enabled/disabled by configuring the claimEnabled object configured in src/config.js.

@username abandon/@username unclaim

Unassigns the commenter from an issue. Works in issue/pull request comments.

• If inProgressLabel is defined in src/config.js and is labeled on the abandoned issue/pull request, a label with the value of inProgressLabel will be removed from the issue/pull request.
• Can be enabled/disabled by configuring the abandonEnabled object configured in src/config.js.

@zulipbot label "label name"

Adds existing repository labels to issues and pull requests. Works in issue descriptions and issue/pull request comments.

• Attempts to add nonexistent repository labels to an issue/pull request will result in an error message.
• Travis build notifications can be added to pull requests using @username label "travisUpdatesLabel" where travisUpdatesLabel is the travisUpdatesLabel configured in src/config.js.
• Configure the selfLabelingOnly object in src/config.js to only allow issue/pull request creators to label their own issues/pull requests.
• Can be enabled/disabled by configuring the labelEnabled object configured in src/config.js.

@zulipbot remove "label name"

Removes labels from issues and pull requests. Works in issue descriptions and issue/pull request comments.

• Attempts to remove invalid labels from an issue/pull request will result in an error message.
• Configure the selfLabelingOnly object in src/config.js to only allow issue/pull request creators to remove labels from their own issues/pull requests.
• Can be enabled/disabled by configuring the removeEnabled object configured in src/config.js.