Gitar Logo

Working with Gitar

How Gitar works with you on your PRs/MRs

Gitar Dashboard

When a new PR/MR is created, Gitar posts a comment used for status updates and controls.

Welcome message

Gitar posts status updates about it's activity by updating this comment in realtime. You can control default behavior like enabling automatic CI failure fixing etc.

CI Failure Analysis & Fixes

When CI fails, Gitar automatically analyzes the failure and posts a comment explaining why. The analysis identifies root causes and provides context before attempting any fixes.

CI Failure Analysis

You can review the analysis to understand what went wrong, then:

  • Check [ ] Automatically accept changes to let Gitar automatically fix the issue
  • Push your own fix with the context from the analysis
  • Comment Gitar <specific instruction> for a targeted fix

Gitar is capable of fixing build errors, linting errors, test failures, and more. The analysis updates dynamically as new commits are pushed.

Address Review Comments

Start comments with Gitar and Gitar will address the comment and push a fix. Gitar only processes comments from users with repository write access for security reasons. Be specific and actionable in your requests.

Gitar reacts to your comment with 👀 to indicate it has started working on it.

Example

Here is an example of Gitar fixing CI failures and addressing user comments on a PR.

After the initial message, a user posts a request via a comment. Gitar acknowledges it is looking at the request. CI has also failed because of test failures.

User Request

After a few minutes, Gitar resolves both issues and pushes commits to the PR and explains what it did. At this point, the user comment as well as CI failures are solved. CI is green and the PR is ready for merging.

Ready to Merge

Repository Rules

Create automated workflows using natural language specified in .gitar/rules/*.md files. When conditions are met, Gitar automatically executes actions - no code required.

You can ask Gitar to

  • Add comments on the PR or inline
  • Do code review and Assign reviewers
  • Apply labels based on conditions
  • And much more

For example, create .gitar/rules/package_upgrades.md:

# Package Upgrade Documentation

When package upgrades are detected:
- Add comment with link to upgrade documentation template
- Assign technical lead as reviewer
- Add "needs-documentation" label

Other Examples

Customize

Gitar uses AGENTS.md files in your repositories to follow the repository conventions and best practices. The following files are recognized as AI instructions sources

  • AGENTS.md
  • CLAUDE.md
  • .cursorrules / Files in .cursor/rules/* directory

Troubleshooting