Document recent goose PRs (#5683)

2025-11-11 13:42:47 -06:00
parent 92d86c0802
commit a2c862b749
5 changed files with 47 additions and 0 deletions
@@ -153,6 +153,26 @@ goose run --debug -t "your instructions"
 goose run --debug --recipe recipe.yaml
 ```

+### JSON Output Format
+
+For automation, scripting, and CI/CD integration, you can get structured output from `goose run` using the `--output-format json` flag:
+
+```bash
+# Run with JSON output for automation
+goose run --output-format json -t "your instructions"
+
+# Run a recipe with JSON output
+goose run --output-format json --recipe recipe.yaml
+
+# Combine with other options
+goose run --output-format json --no-session -t "automated task"
+```
+
+The JSON output includes:
+- Session metadata and execution results
+- Tool outputs and any errors
+- Structured data suitable for parsing by scripts and CI/CD pipelines
+
 ## Common Use Cases

 ### Running Script Files