Skip to main content

Interacting with Gitar

You can interact with Gitar in PR and MR comments. Start your comment with gitar or @gitar (case-insensitive), mention @gitar-bot anywhere in the comment (GitHub), or reply directly to one of Gitar’s comments or inline findings (no prefix needed). On GitLab, you can also mention the connected GitLab account, for example @gitar-service-yourorg. On Azure DevOps Server, follow the comment checkbox instructions if the PR description includes Ask Gitar to read my new comments. Commands need write access to the PR, and bot accounts are ignored unless an admin lists them under Allowed bots in scope settings. Gitar understands natural language. Ask it to fix something, make changes, or answer questions:
  • gitar fix this or reply fix on an inline finding
  • gitar please add a unit test for this
  • gitar why was this file changed?
  • gitar create a Jira ticket for this
Where supported, Gitar reacts with eyes when it starts processing and thumbs-up when a command is processed or an integration request completes. Azure DevOps and both Bitbucket editions do not show these reactions.

Commands

Commands are exact phrases that control Gitar’s behavior on a specific PR. They must match exactly (case-insensitive). Include multiple commands on separate lines. If two conflict, the last one wins.

Unblock

Comment gitar unblock to dismiss Gitar’s blocking review so you can merge immediately. See Block Merge for details on how merge blocking works.
The gitar unblock command must be enabled by an org admin in Settings -> Configuration -> Behavior. The hint in review comments only appears when Gitar is actually blocking the PR. The command is not available on Bitbucket Data Center, where Gitar’s review does not gate the merge.
Trailing punctuation is accepted. Both gitar unblock. and gitar unblock! work.

Auto-Apply

Control whether Gitar automatically commits fixes to your branch for code review findings and CI failures. The preference lasts for the life of the PR. The dashboard comment shows the auto-apply status. Auto-Apply explains how organization and repository criteria limit which review findings Gitar may fix.

Auto-Apply by label

On GitHub and GitLab, gitar-managed enables auto-apply for a PR. See Labels for setting precedence and removal behavior.

Auto-Merge

Override your organization’s auto-merge setting for one PR. The command decides this PR only and holds for the life of it. See Auto-Merge for what has to be true before an armed PR actually merges.

Display Mode

Control how much detail you see in the Gitar dashboard comment. The default is compact mode. Your display preference persists across comment updates. The footer shows a hint for the opposite command. Compact mode (default) shows only applicable rules with a summary of how many were hidden: Verbose mode shows all rules with explanations for why each rule doesn’t apply: