docs: updated docs for smart approval mode (#1853)

This commit is contained in:
Angie Jones
2025-03-25 18:50:54 +01:00
committed by GitHub
parent 26cfd0a49c
commit a166649c73
4 changed files with 86 additions and 70 deletions

View File

@@ -784,7 +784,7 @@ pub fn configure_goose_mode_dialog() -> Result<(), Box<dyn Error>> {
.item(
"approve",
"Approve Mode",
"All tools, extensions and file modificatio will require human approval"
"All tools, extensions and file modifications will require human approval"
)
.item(
"smart_approve",

View File

@@ -13,13 +13,15 @@ Gooses permissions determine how much autonomy it has when modifying files, u
## Permission Modes
| Mode | Description | Best For |
| ---------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| **Auto Mode** | Goose can modify files, use extensions, and delete files **without requiring approval**. | Users who want **full automation** and seamless integration into their workflow. |
| **Approve Mode** | Goose **asks for confirmation** before all tools and extensions. | Users who want to **review and approve** any changes and extension use before they happen. |
| **Chat Mode** | Goose **only engages in chat**, with no extension use or file modifications. | Users who prefer a **conversational AI experience** without automation. |
|--------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
| **Completely Autonomous** | Goose can modify files, use extensions, and delete files **without requiring approval**. | Users who want **full automation** and seamless integration into their workflow. |
| **Manual Approval**| Goose **asks for confirmation** before using any tools or extensions. | Users who want to **review and approve** every change and tool usage. |
| **Smart Approval** | Goose uses a risk-based approach to **automatically approve low-risk actions** and **flag others** for approval. | Users who want a **balanced mix of autonomy and oversight** based on the actions impact. |
| **Chat Only** | Goose **only engages in chat**, with no extension use or file modifications. | Users who prefer a **conversational AI experience** without automation. |
|
:::warning
`Auto Mode` is applied by default.
`Autonoumous Mode` is applied by default.
:::
## Configuring Goose Mode
@@ -28,6 +30,16 @@ Here's how to configure:
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<Tabs>
<TabItem value="session" label="In Session" default>
To change modes mid-session, use the `/mode` command.
* Autonoumous: `/mode auto`
* Approve: `/mode approve`
* Chat: `/mode chat`
</TabItem>
<TabItem value="settings" label="From Settings">
1. Run the following command:
```sh
@@ -82,30 +94,34 @@ Here's how to configure:
│ ● Auto Mode
// highlight-end
| ○ Approve Mode
| ○ Smart Approve Mode
| ○ Chat Mode
|
└ Set to Auto Mode - full file modification enabled
```
</TabItem>
</Tabs>
</TabItem>
<TabItem value="ui" label="Goose Desktop">
You can change modes before or during a session and it will take effect immediately.
**From Settings**
<Tabs>
<TabItem value="session" label="In Session" default>
Click the Goose Mode option from the bottom menu.
</TabItem>
<TabItem value="settings" label="From Settings">
1. Click `...` in the upper right corner
2. Click `Settings`
3. Under `Mode Selection`, choose the mode you'd like
**Within Session**
Click the Goose Mode option from the bottom menu.
</TabItem>
</Tabs>
</TabItem>
</Tabs>
:::info
If you choose `Approve` mode, you will see "Allow" and "Deny" buttons in your session windows during tool calls. Goose will only ask for permission for tools that it deems are 'write' tools, e.g. any 'text editor write', 'text editor edit', 'bash - rm, cp, mv' commands.
If you choose `Approve` mode, you will see "Allow" and "Deny" buttons in your session windows during tool calls.
Goose will only ask for permission for tools that it deems are 'write' tools, e.g. any 'text editor write', 'text editor edit', 'bash - rm, cp, mv' commands.
Read/write approval makes best effort attempt at classifying read or write tools. This is interpreted by your LLM provider.
:::

View File

@@ -18,7 +18,7 @@ export function ConfigureApproveMode({
{
key: 'approve',
label: 'Manual Approval',
description: 'All tools, extensions and file modificatio will require human approval',
description: 'All tools, extensions and file modifications will require human approval',
},
{
key: 'smart_approve',

View File

@@ -17,7 +17,7 @@ export const all_goose_modes: GooseMode[] = [
{
key: 'approve',
label: 'Manual Approval',
description: 'All tools, extensions and file modificatio will require human approval',
description: 'All tools, extensions and file modifications will require human approval',
},
{
key: 'smart_approve',