docs: Add experimental features (#1644)

This commit is contained in:
Adewale Abati
2025-03-13 12:29:58 +01:00
committed by GitHub
parent 2135d8b596
commit f25fc6ad75

View File

@@ -0,0 +1,84 @@
# Experimental Features
Goose is an open source project that is constantly being improved, and new features are added regularly. Some of these features are considered experimental, meaning they are still in development and may not be fully stable or ready for production use. This guide covers how to enable and use experimental features in Goose, as well as how to provide feedback on them.
:::note
Experimental features are new capabilities that are still being tested and refined. While they can provide additional functionality, they may be less stable than standard features.
:::
## Enabling Experimental Features
To access experimental features, run:
```sh
goose configure
```
Select "Goose Settings" from the menu:
```sh
┌ goose-configure
◆ What would you like to configure?
| ○ Configure Providers
| ○ Add Extension
| ○ Toggle Extensions
| ○ Remove Extension
// highlight-next-line
| ● Goose Settings (Set the Goose Mode, Tool Output, Experiment and more)
```
Then select "Toggle Experiment" option in the menu:
```sh
┌ goose-configure
◇ What would you like to configure?
│ Goose Settings
◆ What setting would you like to configure?
│ ○ Goose Mode
│ ○ Tool Output
// highlight-next-line
│ ● Toggle Experiment (Enable or disable an experiment feature)
```
## Available Experimental Features
:::note
The list of experimental features may change as Goose development progresses. Some features may be promoted to stable features, while others might be modified or removed.This section will be updated with specific experimental features as they become available
:::
### Smart Approve
The `GOOSE_SMART_APPROVE` experimental feature when enabled allows Goose to review any commands about to be run to determine their sensitivity. Commands with high sensitivity will require approval from the user before it's executed.
Here's an example when a `write` command is about to be executed
```sh
─── text_editor | developer ──────────────────────────
path: ~/Documents/block/goose/test.txt
command: write
file_text: This is a test file.
// highlight-start
◇ Goose would like to call the above tool, do you approve?
│ Yes
// highlight-end
### /Users/yingjiehe/Documents/block/goose/test.txt
This is a test file.
I've created a file named "test.txt" with some simple content. Let me verify that the file was created by checking its contents:
─── text_editor | developer ──────────────────────────
path: ~/Documents/block/goose/test.txt
command: view
```
## Feedback
If you encounter any issues with these features, check if the issue is already reported in the [GitHub issues](https://github.com/goose/goose/issues) or join the [Discord community](https://discord.gg/block-opensource) to share.