Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dianed-square merged 2 commits into from
Jan 9, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84aa862
stream-json output and auth-token
dianed-square Jan 9, 2026
2b94f96
Update documentation/docs/guides/goose-cli-commands.md
dianed-square Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion documentation/docs/guides/goose-cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ Execute commands from an instruction file or stdin. Check out the [full guide](/
- **`--explain`**: Show a recipe's title, description, and parameters
- **`--render-recipe`**: Print the rendered recipe instead of running it
- **`-q, --quiet`**: Quiet mode. Suppress non-response output, printing only the model response to stdout
- **`--output-format <FORMAT>`**: Output format (`text` or `json`). Default is `text`. Use `json` for automation and scripting
- **`--output-format <FORMAT>`**: Output format (`text`, `json`, or `stream-json`). Default is `text`. Use JSON structured output for automation and scripting: `json` for results after completion, `stream-json` for events as they occur
- **`--provider`**: Specify the provider to use for this session (overrides environment variable)
- **`--model`**: Specify the model to use for this session (overrides environment variable)

Expand Down Expand Up @@ -517,6 +517,7 @@ Don't expose the web interface to the internet without proper security measures.
- **`-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
Copy link
Contributor

@blackgirlbytes blackgirlbytes Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh interesting i didnt know about this.


**Usage:**
```bash
Expand All @@ -528,6 +529,9 @@ goose web --port 8080

# Start web interface accessible from local network at `http://192.168.1.7:8080`
goose web --host 192.168.1.7 --port 8080

# Start web interface with authentication required
goose web --auth-token <TOKEN>
```

:::info
Expand Down
10 changes: 8 additions & 2 deletions documentation/docs/guides/running-tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Loading