tkmind/tkmind_go
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs: stream-json and auth-token cli options (#6426)

Browse Source 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
dianed-square
2026-01-09 15:41:48 -08:00
committed by GitHub
parent 085f48a297
commit 350ab4b96a
2 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/docs/guides/running-tasks.md
+8 -2
View File
@@ -155,12 +155,18 @@ 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:
For automation, scripting, and CI/CD integration, you can get structured output from `goose run` using the `--output-format` flag:
- `json` - Complete JSON output after execution finishes (best for CI pipelines, logging)
- `stream-json` - Real-time structured output as events occur (best for progress monitoring, long-running tasks)
```bash
# Run with JSON output for automation
goose run --output-format json -t "your instructions"
# Stream JSON events in real-time
goose run --output-format stream-json -t "your instructions"
# Run a recipe with JSON output
goose run --output-format json --recipe recipe.yaml
@@ -221,4 +227,4 @@ This command:
2. Adds a custom extension with an API key
3. Names the session "project-setup"
4. Starts with "Initialize project" instruction
5. Exits automatically after processing the command.
5. Exits automatically after processing the command.