Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.joggr.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

/gg-review opens a local review UI in your browser for a plan file or markdown artifact. You read the rendered document, highlight passages, leave inline comments, and submit a decision (approve or request changes). The agent receives your annotations as structured markdown and addresses them automatically. This is the human-in-the-loop checkpoint for Workflows artifacts — plans, phase files, research notes, and other generated markdown. It is not intended for reviewing code changes (use a PR for that).

​
Invocation

/gg-review [path]
  • No argument — auto-detects the active context: defaults to the active task’s spec.md if a task is running, the active project’s phase file if a project is running, or asks which to review if both are active.
  • With a path — reviews the specified markdown file (e.g. .joggr/.gg/projects/my-project/phases/1-setup/phase.md).

​
What It Produces

  • A local web UI rendering the markdown file with a rich text viewer
  • Inline annotations attached to specific text ranges
  • A decision: approve or request changes
  • Structured markdown feedback piped back to the agent

​
Behavior

Under the hood, /gg-review calls jog app --review --file-path="<path>" via a blocking shell command. The full flow:
  1. The CLI starts a local Hono server on a random free port
  2. Your default browser opens to the review UI
  3. You read the document, select text, and add comments
  4. You choose a decision and submit
  5. The CLI prints formatted markdown to stdout
  6. The agent reads the output and addresses each annotation
The agent blocks while you review — take your time. The server shuts down automatically after you submit. When invoked without a path and both a project and a task are active, the agent asks which context to review before opening the UI.
Don’t close the terminal running the review. The server needs to stay alive until you submit your review in the browser. If you accidentally close it, re-run /gg-review on the same file.
Use /gg-review after /gg-plan to review the generated plan before execution begins. Catching scope issues here is much cheaper than fixing them after /gg-execute.