Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
This commit is contained in:
Josh Soref
2026-02-11 09:35:24 -05:00
committed by GitHub
parent 544bc1bc4f
commit f636a97faa
81 changed files with 109 additions and 110 deletions
+1 -1
View File
@@ -29,7 +29,7 @@ body {
}
/* Reduce the space between the term and definition in a definition list
Reads better for flags and their documention in CLI options lists */
Reads better for flags and their documentation in CLI options lists */
.md-typeset dd {
margin-top: 0.125em;
}
@@ -789,7 +789,7 @@ Here are some local providers we support:
6. Enter the host where your model is running
:::info Endpoint
For the Ollama provider, if you don't provide a host, we set it to `localhost:11434`. When constructing the URL, we preprend `http://` if the scheme is not `http` or `https`. Since Ramalama's default port to serve on is 8080, we set `OLLAMA_HOST=http://0.0.0.0:8080`
For the Ollama provider, if you don't provide a host, we set it to `localhost:11434`. When constructing the URL, we prepend `http://` if the scheme is not `http` or `https`. Since Ramalama's default port to serve on is 8080, we set `OLLAMA_HOST=http://0.0.0.0:8080`
:::
```
+1 -1
View File
@@ -228,7 +228,7 @@ I still need some critical information to create a comprehensive plan:
5. Should the application maintain any history of previous search/replace operations?
Without this information, I can only provide a generic plan that might not accurately capture your requirements.
( O)> please provde a generic plan
( O)> please provide a generic plan
```
While goose creates a standardized plan format, it customizes the content based on your answers. goose can generate the code needed to implement the steps of the plan it produces. You should review the plan and any code that it generates before ending plan mode (`/endplan`) and asking goose to implement the plan.
@@ -129,7 +129,7 @@ These variables configure a [lead/worker model pattern](/docs/tutorials/lead-wor
| `GOOSE_LEAD_MODEL` | **Required to enable lead mode.** Name of the lead model | Model name (e.g., "gpt-4o", "claude-sonnet-4-20250514") | None |
| `GOOSE_LEAD_PROVIDER` | Provider for the lead model | [See available providers](/docs/getting-started/providers#available-providers) | Falls back to `GOOSE_PROVIDER` |
| `GOOSE_LEAD_TURNS` | Number of initial turns using the lead model before switching to the worker model | Integer | 3 |
| `GOOSE_LEAD_FAILURE_THRESHOLD` | Consecutive failures before fallback to the lead model | Integer | 2 |
| `GOOSE_LEAD_FAILURE_THRESHOLD` | Consecutive failures before falling back to the lead model | Integer | 2 |
| `GOOSE_LEAD_FALLBACK_TURNS` | Number of turns to use the lead model in fallback mode | Integer | 2 |
A _turn_ is one complete prompt-response interaction. Here's how it works with the default settings:
@@ -226,7 +226,7 @@ These variables control how goose manages conversation sessions and context.
| `GOOSE_CLI_THEME` | [Theme](/docs/guides/goose-cli-commands#themes) for CLI response markdown | "light", "dark", "ansi" | "dark" |
| `GOOSE_CLI_NEWLINE_KEY` | Customize the keyboard shortcut for [inserting newlines in CLI input](/docs/guides/goose-cli-commands#keyboard-shortcuts) | Single character (e.g., "n", "m") | "j" (Ctrl+J) |
| `GOOSE_RANDOM_THINKING_MESSAGES` | Controls whether to show amusing random messages during processing | "true", "false" | "true" |
| `GOOSE_CLI_SHOW_COST` | Toggles display of model cost estimates in CLI output | "true", "1" (case insensitive) to enable | false |
| `GOOSE_CLI_SHOW_COST` | Toggles display of model cost estimates in CLI output | "true", "1" (case-insensitive) to enable | false |
| `GOOSE_AUTO_COMPACT_THRESHOLD` | Set the percentage threshold at which goose [automatically summarizes your session](/docs/guides/sessions/smart-context-management#automatic-compaction). | Float between 0.0 and 1.0 (disabled at 0.0) | 0.8 |
| `GOOSE_TOOL_CALL_CUTOFF` | Number of tool calls to keep in full detail before summarizing older tool outputs to help maintain efficient context usage | Integer (e.g., 5, 10, 20) | 10 |
@@ -311,11 +311,11 @@ These variables control how goose handles [tool execution](/docs/guides/goose-pe
| Variable | Purpose | Values | Default |
|----------|---------|---------|---------|
| `GOOSE_MODE` | Controls how goose handles tool execution | "auto", "approve", "chat", "smart_approve" | "smart_approve" |
| `GOOSE_TOOLSHIM` | Enables/disables tool call interpretation | "1", "true" (case insensitive) to enable | false |
| `GOOSE_TOOLSHIM` | Enables/disables tool call interpretation | "1", "true" (case-insensitive) to enable | false |
| `GOOSE_TOOLSHIM_OLLAMA_MODEL` | Specifies the model for [tool call interpretation](/docs/experimental/ollama) | Model name (e.g. llama3.2, qwen2.5) | System default |
| `GOOSE_CLI_MIN_PRIORITY` | Controls verbosity of [tool output](/docs/guides/managing-tools/adjust-tool-output) | Float between 0.0 and 1.0 | 0.0 |
| `GOOSE_CLI_TOOL_PARAMS_TRUNCATION_MAX_LENGTH` | Maximum length for tool parameter values before truncation in CLI output (not in debug mode) | Integer | 40 |
| `GOOSE_DEBUG` | Enables debug mode to show full tool parameters without truncation. Can also be toggled during a session using the `/r` [slash command](/docs/guides/goose-cli-commands#slash-commands) | "1", "true" (case insensitive) to enable | false |
| `GOOSE_DEBUG` | Enables debug mode to show full tool parameters without truncation. Can also be toggled during a session using the `/r` [slash command](/docs/guides/goose-cli-commands#slash-commands) | "1", "true" (case-insensitive) to enable | false |
| `GOOSE_SEARCH_PATHS` | Additional directories to search for executables when running extensions | JSON array of paths (e.g., `["/usr/local/bin", "~/custom/bin"]`) | System PATH only | No |
**Examples**
@@ -504,7 +504,7 @@ These variables enable experimental features that are in active development. The
| Variable | Purpose | Values | Default |
|----------|---------|---------|---------|
| `ALPHA_FEATURES` | Enables experimental alpha features&mdash;check the feature docs to see if this flag is required | "true", "1" (case insensitive) to enable | false |
| `ALPHA_FEATURES` | Enables experimental alpha features&mdash;check the feature docs to see if this flag is required | "true", "1" (case-insensitive) to enable | false |
**Examples**
@@ -187,7 +187,7 @@ Start or resume interactive chat sessions.
- **`-n, --name <name>`**: Give the session a name
- **`--path <path>`**: Legacy parameter for specifying session by file path
- **`-r, --resume`**: Resume a previous session
- **`--fork`**: Create a new duplicate session with copied history. Must be used with `--resume`. Provide `--name` or `--session-id` to fork a specific session. Otherwise forks the most recent session.
- **`--fork`**: Create a new duplicate session with copied history. Must be used with `--resume`. Provide `--name` or `--session-id` to fork a specific session. Otherwise, forks the most recent session.
- **`--history`**: Show previous messages when resuming a session
- **`--container <container_id>`**: Run extensions inside a [Docker container](/docs/tutorials/goose-in-docker#running-extensions-in-docker-containers).
- **`--debug`**: Enable debug mode to output complete tool responses, detailed parameter values, and full file paths
+2 -2
View File
@@ -79,7 +79,7 @@ By connecting to the ElevenLabs MCP server, goose can transform plain text into
### goose Prompt
> Hey goose, create a script for me for my youtube short video, I want there to be two different voices. The first voice should cut me off and be a human narrator style and then switch to a cassual AI tone after I read the prompt. Here's an example of a YT short script I've done in the past:
> Hey goose, create a script for me for my youtube short video, I want there to be two different voices. The first voice should cut me off and be a human narrator style and then switch to a casual AI tone after I read the prompt. Here's an example of a YT short script I've done in the past:
Wait… Within Seconds, goose performed Security Audits Across Multiple Projects?! 🔥
@@ -88,7 +88,7 @@ Lets, plug & play to find out how
Lets provide goose with the command it needs to connect to the Filesystem MCP server extension…
Now lets play
propmt: "Hey goose, I need to perform a security audit across multiple projects. Let's check for…🔹 Hardcoded Credentials API keys, passwords, and secrets left in the code.🔹 SQL Injection Risks Unsafe queries that could expose data.🔹 Insecure Cryptographic Practices Weak encryption methods that put data at risk.AND🔹 Exposed Config Files Sensitive information that shouldn't be public.🔹 Outdated Dependencies Security vulnerabilities in third-party libraries."
prompt: "Hey goose, I need to perform a security audit across multiple projects. Let's check for…🔹 Hardcoded Credentials API keys, passwords, and secrets left in the code.🔹 SQL Injection Risks Unsafe queries that could expose data.🔹 Insecure Cryptographic Practices Weak encryption methods that put data at risk.AND🔹 Exposed Config Files Sensitive information that shouldn't be public.🔹 Outdated Dependencies Security vulnerabilities in third-party libraries."
Go goose, go goose!
@@ -104,7 +104,7 @@ The bug report feature opens a structured GitHub issue template to help you prov
<TabItem value="ui" label="goose Desktop" default>
1. In an active chat session, look for the <Bug className="inline" size={16} /> icon in the bottom toolbar
2. Click the diagnostics button
3. Click `File Bug on Github`
3. Click `File Bug on GitHub`
4. This opens GitHub in your browser with a pre-filled bug report template
</TabItem>
<TabItem value="cli" label="goose CLI">
@@ -14,7 +14,7 @@ goose allows you to extend its functionality by creating your own custom extensi
In this guide, we build an MCP server using the [Python SDK for MCP][mcp-python]. Well demonstrate how to create an MCP server that reads Wikipedia articles and converts them to Markdown, integrate it as an extension in goose. You can follow a similar process to develop your own custom extensions for goose.
You can check out other example servers in the [MCP servers repository][mcp-servers]. MCP SDKs are also available for other common languages, such as [Typescript][mcp-typescript] and [Kotlin][mcp-kotlin].
You can check out other example servers in the [MCP servers repository][mcp-servers]. MCP SDKs are also available for other common languages, such as [TypeScript][mcp-typescript] and [Kotlin][mcp-kotlin].
:::info
goose supports Tools, Resources, and Prompts from the [Model Context Protocol](https://modelcontextprotocol.io/). See [`mcp_client.rs`](https://github.com/block/goose/blob/main/crates/goose/src/agents/mcp_client.rs) for the supported protocol version and client capabilities.
@@ -211,7 +211,7 @@ Verify that your MCP server is running in the MCP Inspector (a browser-based dev
MCP Inspector requires Node.js and npm installed on your computer.
:::
1. Setup the project environment:
1. Set up the project environment:
```bash
uv sync
@@ -240,7 +240,7 @@ MCP Inspector requires Node.js and npm installed on your computer.
</TabItem>
<TabItem value="cli" label="In the CLI">
1. Setup the project environment:
1. Set up the project environment:
```bash
uv sync
+1 -1
View File
@@ -13,7 +13,7 @@ This tutorial covers how to integrate goose with Langfuse to monitor your goose
## Set up Langfuse
Sign up for Langfuse Cloud [here](https://cloud.langfuse.com) or self-host Langfuse [Docker Compose](https://langfuse.com/self-hosting/local) to get your Langfuse API keys.
[Sign up for Langfuse Cloud](https://cloud.langfuse.com) or self-host Langfuse [Docker Compose](https://langfuse.com/self-hosting/local) to get your Langfuse API keys.
## Configure goose to Connect to Langfuse
+1 -1
View File
@@ -59,7 +59,7 @@ Ensure you have [added the LLMs to goose](/docs/getting-started/providers)
2. Click **Lead/Worker Settings**
3. Check the box to **Enable lead/worker mode**
4. Select your **Lead Model** and **Worker Model** from the dropdown menus
5. (Optional) Change the default number of **initial lead turns**, the **failure threshold** before switching back to the leavd model, or the number of **fallback turns** to use the lead model during fallback
5. (Optional) Change the default number of **initial lead turns**, the **failure threshold** before switching back to the lead model, or the number of **fallback turns** to use the lead model during fallback
</TabItem>
<TabItem value="cli" label="goose CLI">
The only required configuration is setting the `GOOSE_LEAD_MODEL` [environment variable](/docs/guides/environment-variables#leadworker-model-configuration):