Skip to content

docs: updated docs for smart approval mode #1853

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
angiejones merged 2 commits into from
Mar 25, 2025
Merged

docs: updated docs for smart approval mode #1853

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
dcca542
docs: updated docs for smart approval mode
angiejones Mar 25, 2025
8e5c4ce
added in-session CLI instructions
angiejones Mar 25, 2025
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
2 changes: 1 addition & 1 deletion crates/goose-cli/src/commands/configure.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
164 changes: 90 additions & 74 deletions documentation/docs/guides/goose-permissions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@ Goose’s 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. |
| Mode | Description | Best For |
|--------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
| **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 action’s 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
Expand All @@ -28,84 +30,98 @@ Here's how to configure:

<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
1. Run the following command:

```sh
goose configure
```

2. Select `Goose Settings` from the menu and press Enter.

```sh
┌ goose-configure
│
◆ What would you like to configure?
| ○ Configure Providers
| ○ Add Extension
| ○ Toggle Extensions
| ○ Remove Extension
// highlight-start
| ● Goose Settings (Set the Goose Mode, Tool Output, Experiment and more)
// highlight-end
└
```

3. Choose `Goose Mode` from the menu and press Enter.

```sh
┌ goose-configure
│
◇ What would you like to configure?
│ Goose Settings
│
◆ What setting would you like to configure?
// highlight-start
│ ● Goose Mode (Configure Goose mode)
// highlight-end
| ○ Tool Output
└
```

4. Choose the Goose mode you would like to configure.

```sh
┌ goose-configure
│
◇ What would you like to configure?
│ Goose Settings
│
◇ What setting would you like to configure?
│ Goose Mode
│
◆ Which Goose mode would you like to configure?
// highlight-start
│ ● Auto Mode
// highlight-end
| ○ Approve Mode
| ○ Chat Mode
|
└ Set to Auto Mode - full file modification enabled
```

<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
goose configure
```

2. Select `Goose Settings` from the menu and press Enter.

```sh
┌ goose-configure
│
◆ What would you like to configure?
| ○ Configure Providers
| ○ Add Extension
| ○ Toggle Extensions
| ○ Remove Extension
// highlight-start
| ● Goose Settings (Set the Goose Mode, Tool Output, Experiment and more)
// highlight-end
└
```

3. Choose `Goose Mode` from the menu and press Enter.

```sh
┌ goose-configure
│
◇ What would you like to configure?
│ Goose Settings
│
◆ What setting would you like to configure?
// highlight-start
│ ● Goose Mode (Configure Goose mode)
// highlight-end
| ○ Tool Output
└
```

4. Choose the Goose mode you would like to configure.

```sh
┌ goose-configure
│
◇ What would you like to configure?
│ Goose Settings
│
◇ What setting would you like to configure?
│ Goose Mode
│
◆ Which Goose mode would you like to configure?
// highlight-start
│ ● 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**

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.
<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
</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.
:::
2 changes: 1 addition & 1 deletion ui/desktop/src/components/settings/basic/ConfigureApproveMode.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion ui/desktop/src/components/settings/basic/ModeSelectionItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
Loading