docs: description required for "Add Extension" in cli - phase 2 (#5635)

This commit is contained in:
dianed-square
2025-11-07 13:27:57 -08:00
committed by GitHub
parent 4b0bef18ae
commit 65b4b2bb18
32 changed files with 608 additions and 3865 deletions
+30 -72
View File
@@ -1,17 +1,17 @@
---
title: Tutorial Extension
description: Learn how to use Goose's built-in Tutorial extension for guided learning
description: Learn how to use goose's built-in Tutorial extension for guided learning
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import GooseBuiltinInstaller from '@site/src/components/GooseBuiltinInstaller';
The Tutorial extension is a built-in feature of Goose that provides interactive, step-by-step guidance for learning various aspects of Goose and its capabilities. It's designed to help users get comfortable with Goose's features through hands-on practice.
The Tutorial extension is a built-in feature of goose that provides interactive, step-by-step guidance for learning various aspects of goose and its capabilities. It's designed to help users get comfortable with goose's features through hands-on practice.
The Tutorial extension serves as an interactive learning tool that:
- Provides structured, step-by-step tutorials
- Allows hands-on practice with Goose features
- Allows hands-on practice with goose features
- Offers immediate feedback and guidance
## Configuration
@@ -26,67 +26,25 @@ The Tutorial extension serves as an interactive learning tool that:
</TabItem>
<TabItem value="cli" label="goose CLI">
```sh
goose configure
```
1. Run the `configure` command:
```sh
goose configure
```
2. Choose to add a `Built-in Extension`
```sh
┌ goose-configure
◇ What would you like to configure?
Add Extension (Connect to a new extension)
◆ What type of extension would you like to add?
// highlight-start
│ ● Built-in Extension (Use an extension that comes with Goose)
// highlight-end
│ ○ Command-line Extension
○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
```
3. Select the `Tutorial` extension
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add?
│ Built-in Extension
◆ Which built-in extension would you like to enable?
│ ○ Developer Tools
│ ○ Computer Controller
// highlight-start
│ ● Tutorial
// highlight-end
│ ○ Memory
| ○ JetBrains
```
4. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add?
│ Built-in Extension
◇ Which built-in extension would you like to enable?
│ Tutorial
// highlight-start
◆ Please set the timeout for this tool (in secs):
300
// highlight-end
└ Enabled Tutorials extension
```
2. Choose to `Toggle Extensions`
```sh
┌ goose-configure
◇ What would you like to configure?
│ Toggle Extensions
◆ Enable extensions: (use "space" to toggle and "enter" to submit)
// highlight-start
│ ● tutorial
// highlight-end
|
Extension settings updated successfully
```
</TabItem>
</Tabs>
@@ -95,7 +53,7 @@ goose configure
Currently, the following tutorials are available:
- **build-mcp-extension**: Learn how to build an extension using the Model Context Protocol (MCP)
- **first-game**: Create your first game with Goose
- **first-game**: Create your first game with goose
More tutorials are being added regularly to cover additional features and use cases.
@@ -105,10 +63,10 @@ More tutorials are being added regularly to cover additional features and use ca
There are two main ways to interact with tutorials:
1. **Ask Goose directly**: You can simply ask about a topic you're interested in, and Goose will suggest relevant tutorials.
1. **Ask goose directly**: You can simply ask about a topic you're interested in, and goose will suggest relevant tutorials.
```
( O)> I'd like to learn how to build an extension for Goose
( O)> I'd like to learn how to build an extension for goose
```
2. **Request a specific tutorial**: You can directly request a tutorial by name.
@@ -121,7 +79,7 @@ There are two main ways to interact with tutorials:
While going through a tutorial:
1. Goose will guide you step-by-step through the process
1. goose will guide you step-by-step through the process
2. You'll receive clear instructions before any actions are taken
3. You can ask questions at any time for clarification
4. You can take breaks and resume later
@@ -129,7 +87,7 @@ While going through a tutorial:
### Best Practices
- **Take your time**: Don't rush through the tutorials. Make sure you understand each step before moving on.
- **Ask questions**: If something isn't clear, ask Goose to explain it further.
- **Ask questions**: If something isn't clear, ask goose to explain it further.
- **Experiment**: Feel free to try variations of what you're learning.
- **Take notes**: Document any interesting findings or techniques you learn.
@@ -139,12 +97,12 @@ While going through a tutorial:
Here's an example of how to start learning about building extensions:
### Goose Prompt
### goose Prompt
```
I'd like to learn how to build an extension for Goose
I'd like to learn how to build an extension for goose
```
### Goose Output
### goose Output
```
I'll help you learn about building extensions! The "build-mcp-extension" tutorial would be perfect for this. Let me load it and guide you through it.
@@ -180,7 +138,7 @@ Which SDK would you like to use to get started?
After completing tutorials, you can:
- Apply learned concepts to your own projects
- Contribute to the Goose community by sharing your experiences
- Contribute to the goose community by sharing your experiences
- Suggest new tutorial topics that would be helpful for others
### Need Further Help?