Skip to main content

​
Commands

You can control ZAR without leaving GitHub by mentioning it in a pull request or issue comment. Commands are the fastest way to set a style, toggle a feature, or force a docs update.

​
Triggers

Start a comment with any of these (case-insensitive): 
@docagent …
/docagent …
@zar …
/zar …
All four are equivalent. The rest of the comment is the command.

​
Who can run them

The comment author needs write access to the repository. Owners, members, and collaborators are recognized automatically; for anyone else ZAR checks GitHub for write, maintain, or admin permission. Without it, ZAR replies that the command was refused. This keeps configuration changes in the hands of people who can already change the repo.

​
Available commands

CommandWhat it does
helpList the commands with examples.
statusShow current CI gate, auto-commit, and style-guide settings.
style "<text>"Set the documentation style guide.
enable ci-gate / disable ci-gateTurn the CI gate on/off.
enable auto-commit / disable auto-commitTurn auto-commit on/off.
update docs nowForce a docs analysis on the current PR, ignoring trigger mode.
ci-gate / ci gate and auto-commit / auto commit are both accepted (dash or space).

​
Examples

@docagent help

@docagent status

@docagent style "Write like Stripe: short sentences, params in tables, one code example per endpoint."

@docagent enable ci-gate

@zar update docs now

​
Notes

  • style accepts quoted ("…" or '…') or unquoted text. Quotes are clearest when your style includes punctuation.
  • update docs now only makes sense on a pull request; on a plain issue there’s no diff to analyze. Variants like update, update docs, and update documentation now all work.
  • ZAR replies in a threaded comment confirming what it did (or explaining why it couldn’t).
  • Commands change settings immediately; there’s no separate apply step.

​
Full syntax reference

For the exact accepted forms, aliases, and edge cases, see the Commands reference.

​
Next steps