docs: stream-json and auth-token cli options#6426
Merged
dianed-square merged 2 commits intomainfrom Jan 9, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR documents two CLI options: the new --output-format stream-json option for real-time structured output and the --auth-token option for securing the web interface.
- Adds documentation for
stream-jsonoutput format with clear use case distinctions - Documents the
--auth-tokenoption for web command authentication - Includes practical examples for both new options
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| documentation/docs/guides/running-tasks.md | Expands JSON Output Format section with stream-json details and use case guidance |
| documentation/docs/guides/goose-cli-commands.md | Updates --output-format documentation to include stream-json and adds --auth-token option for web command |
Contributor
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| - **`-p, --port <PORT>`**: Port number to run the web server on. Default is `3000` | ||
| - **`--host <HOST>`**: Host to bind the web server to. Default is `127.0.0.1` | ||
| - **`--open`**: Automatically open the browser when the server starts | ||
| - **`--auth-token <TOKEN>`**: Require a password to access the web interface |
Contributor
There was a problem hiding this comment.
oh interesting i didnt know about this.
blackgirlbytes
approved these changes
Jan 9, 2026
zanesq
added a commit
that referenced
this pull request
Jan 12, 2026
…ased * 'main' of github.com:block/goose: chore: break up process agent response (#6348) More 3.7 removal (#6414) CLI show extension errors (#6398) fix[desktop]: Improve UX for ExtensionItem component (#6443) update[doc]: Add tip for GitHub Copilot Provider (#6441) Avoid using cliclack.confirm in non-interactive session (#6412) docs: claude prompt caching note (#6429) Restore task completion notification (#6427) docs: stream-json and auth-token cli options (#6426)
fbalicchia
pushed a commit
to fbalicchia/goose
that referenced
this pull request
Jan 13, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR documents the new
--output-format stream-jsonoption and the--auth-tokenoption for the web command.Documentation updates:
documentation/docs/guides/goose-cli-commands.md:stream-jsonoption--auth-tokenoption (added in earlier release)documentation/docs/guides/running-tasks.md:stream-jsondetails and examplesType of Change
AI Assistance
Testing
Manual testing