mirror of
https://github.com/aljazceru/goose.git
synced 2025-12-17 22:24:21 +01:00
Streamable HTTP CLI flag (#3394)
This commit is contained in:
@@ -32,7 +32,7 @@ goose configure
|
||||
|
||||
### session [options]
|
||||
|
||||
- Start a session and give it a name
|
||||
#### Start a session and give it a name
|
||||
|
||||
**Options:**
|
||||
|
||||
@@ -43,8 +43,9 @@ goose configure
|
||||
```bash
|
||||
goose session --name <n>
|
||||
```
|
||||
---
|
||||
|
||||
- Resume a previous session
|
||||
#### Resume a previous session
|
||||
|
||||
**Options:**
|
||||
|
||||
@@ -59,8 +60,9 @@ goose configure
|
||||
```bash
|
||||
goose session --resume --id <id>
|
||||
```
|
||||
---
|
||||
|
||||
- Start a session with the specified extension
|
||||
#### Start a session with the specified extension
|
||||
|
||||
**Options:**
|
||||
|
||||
@@ -83,8 +85,9 @@ goose configure
|
||||
```bash
|
||||
goose session --with-extension "GITHUB_PERSONAL_ACCESS_TOKEN=<YOUR_TOKEN> npx -y @modelcontextprotocol/server-github"
|
||||
```
|
||||
---
|
||||
|
||||
- Start a session with the specified remote extension over SSE
|
||||
#### Start a session with the specified remote extension over SSE
|
||||
|
||||
**Options:**
|
||||
|
||||
@@ -102,7 +105,48 @@ goose configure
|
||||
goose session --with-remote-extension "http://localhost:8080/sse"
|
||||
```
|
||||
|
||||
- Start a session with the specified [built-in extension](/docs/getting-started/using-extensions#built-in-extensions) enabled (e.g. 'developer')
|
||||
---
|
||||
|
||||
#### Start a session with the specified remote extension over Streaming HTTP
|
||||
|
||||
**Options:**
|
||||
|
||||
**`--with-streamable-http-extension <url>`**
|
||||
|
||||
**Usage:**
|
||||
|
||||
```bash
|
||||
goose session --with-streamable-http-extension <url>
|
||||
```
|
||||
|
||||
**Examples:**
|
||||
|
||||
```bash
|
||||
goose session --with-streamable-http-extension "https://example.com/streamable"
|
||||
```
|
||||
|
||||
**Advanced Examples:**
|
||||
|
||||
```bash
|
||||
# Start a session with a streamable HTTP extension
|
||||
goose session --with-streamable-http-extension "http://api.example.com"
|
||||
|
||||
# Use multiple streamable HTTP extensions
|
||||
goose session \
|
||||
--with-streamable-http-extension "http://api1.example.com" \
|
||||
--with-streamable-http-extension "http://api2.example.com"
|
||||
|
||||
# Mix different extension types
|
||||
goose session \
|
||||
--with-extension "echo hello" \
|
||||
--with-remote-extension "http://sse.example.com/sse" \
|
||||
--with-streamable-http-extension "http://http.example.com" \
|
||||
--with-builtin "developer"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### Start a session with the specified [built-in extension](/docs/getting-started/using-extensions#built-in-extensions) enabled (e.g. 'developer')
|
||||
|
||||
**Options:**
|
||||
|
||||
@@ -119,8 +163,9 @@ goose configure
|
||||
```bash
|
||||
goose session --with-builtin computercontroller
|
||||
```
|
||||
---
|
||||
|
||||
- Enable debug mode to output complete tool responses, detailed parameter values, and full file paths
|
||||
#### Enable debug mode to output complete tool responses, detailed parameter values, and full file paths
|
||||
|
||||
**Options:**
|
||||
|
||||
@@ -131,8 +176,9 @@ goose configure
|
||||
```bash
|
||||
goose session --name my-session --debug
|
||||
```
|
||||
---
|
||||
|
||||
- Limit the maximum number of turns the agent can take before asking for user input to continue
|
||||
#### Limit the maximum number of turns the agent can take before asking for user input to continue
|
||||
|
||||
**Options:**
|
||||
|
||||
@@ -144,7 +190,9 @@ goose configure
|
||||
goose session --max-turns 50
|
||||
```
|
||||
|
||||
- Set the [maximum number of turns](/docs/guides/smart-context-management#maximum-turns) allowed without user input (default: 1000)
|
||||
---
|
||||
|
||||
#### Set the [maximum number of turns](/docs/guides/smart-context-management#maximum-turns) allowed without user input (default: 1000)
|
||||
|
||||
**Options:**
|
||||
|
||||
@@ -170,6 +218,7 @@ goose configure
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### session list [options]
|
||||
|
||||
List all saved sessions.
|
||||
@@ -326,6 +375,8 @@ Execute commands from an instruction file or stdin. Check out the [full guide](/
|
||||
- **`--recipe <RECIPE_FILE_NAME> <OPTIONS>`**: Load a custom recipe in current session
|
||||
- **`-p, --path <PATH>`**: Path for this run session (e.g. `./playground.jsonl`)
|
||||
- **`--with-extension <COMMAND>`**: Add stdio extensions (can be used multiple times in the same command)
|
||||
- **`--with-remote-extension <URL>`**: Add remote extensions over SSE (can be used multiple times in the same command)
|
||||
- **`--with-streamable-http-extension <URL>`**: Add remote extensions over Streaming HTTP (can be used multiple times in the same command)
|
||||
- **`--with-builtin <n>`**: Add builtin extensions by name (e.g., 'developer' or multiple: 'developer,github')
|
||||
- **`--debug`**: Output complete tool responses, detailed parameter values, and full file paths
|
||||
- **`--max-turns <NUMBER>`**: [Maximum number of turns](/docs/guides/smart-context-management#maximum-turns) allowed without user input (default: 1000)
|
||||
|
||||
@@ -100,7 +100,7 @@ goose run --no-session -t "your command here"
|
||||
|
||||
### Working with Extensions
|
||||
|
||||
If you want to ensure specific extensions are available when running your task, you can indicate this with arguments. This can be done using the `--with-extension`, `--with-remote-extension`, or `--with-builtin` flags:
|
||||
If you want to ensure specific extensions are available when running your task, you can indicate this with arguments. This can be done using the `--with-extension`, `--with-remote-extension`, `--with-streamable-http-extension`, or `--with-builtin` flags:
|
||||
|
||||
- Using built-in extensions e.g developer and computercontroller extensions
|
||||
|
||||
@@ -120,6 +120,12 @@ goose run --with-extension "ENV1=value1 custom-extension-args" -t "your instruct
|
||||
goose run --with-remote-extension "url" -t "your instructions"
|
||||
```
|
||||
|
||||
- Using streamable HTTP extensions
|
||||
|
||||
```bash
|
||||
goose run --with-streamable-http-extension "https://example.com/streamable" -t "your instructions"
|
||||
```
|
||||
|
||||
### Debug Mode
|
||||
|
||||
When troubleshooting or developing complex workflows, you can enable debug mode to get more detailed information about tool execution. The `--debug` flag provides:
|
||||
|
||||
Reference in New Issue
Block a user