-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Recipe library doc #3329
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.
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
Merged
Recipe library doc #3329
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
68107b2
docs: add recipe library guide
blackgirlbytes 56ed9a1
changing title
blackgirlbytes a91945f
final
blackgirlbytes 4656d93
add to landing page
blackgirlbytes d9d1336
Update documentation/docs/guides/recipes/storing-recipes.md
blackgirlbytes 410ec54
Update documentation/docs/guides/recipes/storing-recipes.md
blackgirlbytes af741cd
Update documentation/docs/guides/recipes/storing-recipes.md
blackgirlbytes 0af3281
Update documentation/docs/guides/recipes/storing-recipes.md
blackgirlbytes 95abc76
Update documentation/docs/guides/recipes/index.md
blackgirlbytes 773f077
Apply suggestions from code review
blackgirlbytes 3d2a65e
Update documentation/docs/guides/recipes/storing-recipes.md
blackgirlbytes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| --- | ||
| title: Storing Recipes | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
| sidebar_position: 4 | ||
| sidebar_label: Storing Recipes | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
| --- | ||
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| This guide covers storing, organizing, and finding Goose recipes when you need to access them again later. | ||
|
|
||
| :::info Desktop UI vs CLI | ||
| - **Goose Desktop** has a visual Recipe Library for browsing and managing saved recipes | ||
| - **Goose CLI** stores recipes as files that you find using file paths or environment variables | ||
| ::: | ||
|
|
||
| ## Understanding Recipe Storage | ||
|
|
||
| Before saving recipes, it's important to understand where they can be stored and how this affects their availability. | ||
|
|
||
| ### Recipe Storage Locations | ||
|
|
||
| | Type | Location | Availability | Best For | | ||
| |------|----------|-------------|----------| | ||
| | **Global** | `~/.config/goose/recipes/` | All projects and sessions | Personal workflows, general-purpose recipes | | ||
| | **Local** | `YOUR_WORKING_DIRECTORY/.goose/recipes/` | Only when working in that project | Project-specific workflows, team recipes | | ||
|
|
||
| **Choose Global Storage When:** | ||
| - You want the recipe available across all projects | ||
| - It's a personal workflow or general-purpose recipe | ||
| - You're the primary user of the recipe | ||
|
|
||
| **Choose Local Storage When:** | ||
| - The recipe is specific to a particular project | ||
| - You're working with a team and want to share the recipe | ||
| - The recipe depends on project-specific files or configurations | ||
|
|
||
|
|
||
| ## Saving Recipes | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
|
|
||
| <Tabs groupId="interface"> | ||
| <TabItem value="desktop" label="Goose Desktop" default> | ||
|
|
||
| **Save New Recipe:** | ||
| 1. To create a recipe from your chat session, see: [Create Recipe from Session](/docs/guides/recipes/session-recipes#create-recipe) | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
| 2. Once in the Recipe Editor, click **"Save Recipe"** to save it to your Recipe Library | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
|
|
||
| **Save Modified Recipe:** | ||
|
|
||
| If you're already using a recipe and want to save a modified version: | ||
| 1. Click the **"⚙️"** (settings) button in the top right | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
| 2. Click **"Save recipe"** | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
| 3. Enter a name for the recipe | ||
| 4. [Choose to save globally or locally](#recipe-storage-locations) to your current project | ||
| 5. Click **"Save Recipe"** | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
|
|
||
| </TabItem> | ||
| <TabItem value="cli" label="Goose CLI"> | ||
|
|
||
| When you [create a recipe](/docs/guides/recipes/recipe-reference), it gets saved to: | ||
|
|
||
| * Your working directory by default: `./recipe.yaml` | ||
| * Any path you specify: `/recipe /path/to/my-recipe.yaml` | ||
| * Local project recipes: `/recipe .goose/recipes/my-recipe.yaml` | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
|
|
||
| ## Finding Your Recipes | ||
|
|
||
| <Tabs groupId="interface"> | ||
| <TabItem value="desktop" label="Goose Desktop" default> | ||
|
|
||
| **Access Recipe Library:** | ||
| 1. Click the `⚙️` (settings) button in the top right | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
| 2. Click **Recipe Library** | ||
| 3. Browse your saved recipes in a list view | ||
| 4. Each recipe shows its title, description, and whether it's global or local | ||
|
|
||
| </TabItem> | ||
| <TabItem value="cli" label="Goose CLI"> | ||
|
|
||
| To find and configure your saved recipes: | ||
|
|
||
| **Browse recipe directories:** | ||
| ```bash | ||
| # List recipes in default global location | ||
| ls ~/.config/goose/recipes/ | ||
|
|
||
| # List recipes in current project | ||
| ls .goose/recipes/ | ||
|
|
||
| # Search for all recipe files | ||
| find . -name "*.md" -path "*/recipes/*" | ||
| ``` | ||
|
|
||
| :::tip | ||
| Set up [custom recipe paths](/docs/guides/recipes/session-recipes#configure-recipe-location) to organize recipes in specific directories or access recipes from a shared GitHub repository. | ||
| ::: | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Using Saved Recipes | ||
|
|
||
| <Tabs groupId="interface"> | ||
| <TabItem value="desktop" label="Goose Desktop" default> | ||
|
|
||
| 1. Click the `⚙️` (settings) button in the top right | ||
|
blackgirlbytes marked this conversation as resolved.
Outdated
|
||
| 2. Click **Recipe Library** | ||
| 3. Find your recipe in the Recipe Library | ||
| 4. Choose one of the following: | ||
| - Click **Use Recipe** to run it immediately | ||
| - Click **Preview** to see details first, then click **Load Recipe** to run it | ||
|
|
||
| </TabItem> | ||
| <TabItem value="cli" label="Goose CLI"> | ||
|
|
||
| Once you've located your recipe file, [run the recipe](/docs/guides/recipes/session-recipes#run-a-recipe). | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.