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.

When Workflows generates a plan, phase file, or other markdown artifact, you can review it interactively before the agent moves on. The review UI renders the document in your browser, lets you highlight text and leave inline comments, and pipes your feedback back to the agent as structured markdown.

​
Prerequisites

  • Joggr CLI installed — complete Install the CLI first
  • A markdown file to review — typically a plan or phase file generated by /gg-plan or other Workflows steps

​
1. Open the review

Run /gg-review: 
/gg-review
Workflows opens the active GG project’s artifact in your browser. If you want to review a specific file, pass the path: 
/gg-review .joggr/.gg/projects/my-project/phases/1-setup/phase.md
If the browser doesn’t open automatically, copy the URL printed in the terminal.

​
2. Add annotations

Select a passage of text you want to comment on. A comment input appears — write your feedback for that specific range and save it.
Adding an inline annotation to a text selection
Add as many annotations as you need. Each one is attached to the exact text you highlighted.

​
3. Choose a decision

Review UI with the decision panel on the right
When you’re done annotating, pick one:
DecisionWhen to use
ApproveThe document is good — no changes needed
Request changesThe agent must address your annotations before continuing

​
4. Submit

Hit submit. The review server persists your annotations, the CLI prints formatted markdown to stdout, and the agent picks up your feedback automatically.
Review submitted confirmation screen
The agent addresses each annotation inline — fixing text, adding missing sections, or replying to explain why something was left as-is.
Use /gg-review after /gg-plan to review the generated plan before execution begins. Catching scope or task issues here is much cheaper than fixing them after /gg-execute.

​
Troubleshooting

Copy the URL from the terminal and paste it manually. This happens on headless environments or when no default browser is set.
Don’t close the terminal running the review. The server must stay alive until you submit in the browser. If you closed it accidentally, re-run /gg-review on the same file.
Make sure you submitted the review (not just added annotations). The agent only receives feedback after you click submit and choose a decision.
Next: Build a Feature — full end-to-end workflow including review checkpoints.