docs: create/edit recipe button (#6145)
This commit is contained in:
dianed-square
@@ -6,7 +6,8 @@ description: "Share a goose session setup (including tools, goals, and instructi
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import { PanelLeft, Bot, SquarePen, Link, Calendar, Terminal } from 'lucide-react';
|
||||
import { PanelLeft, ChefHat, SquarePen, Link, Clock, Terminal } from 'lucide-react';
|
||||
import RecipeFields from '@site/src/components/RecipeFields';
|
||||
|
||||
Sometimes you finish a task in goose and realize, "Hey, this setup could be useful again." Maybe you have curated a great combination of tools, defined a clear goal, and want to preserve that flow. Or maybe you're trying to help someone else replicate what you just did without walking them through it step by step.
|
||||
|
||||
@@ -21,30 +22,23 @@ You can turn your current goose session into a reusable recipe that includes the
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="session" label="Current Session" default>
|
||||
1. While in the session you want to save as a recipe, click the <Bot className="inline" size={16} /> button at the bottom of the app
|
||||
2. Click `Create a recipe from this session`
|
||||
3. A dialog opens with automatically generated instructions and activities:
|
||||
- Provide a **title** and **description** for the recipe
|
||||
- Review the **instructions** and edit them as needed
|
||||
- Provide an optional **initial prompt** to display in the chat box
|
||||
- Add or remove optional **activities** to display as buttons
|
||||
4. When you're finished, you can:
|
||||
- Copy the recipe link to share the recipe with others or [open it from the link](#use-recipe)
|
||||
- Click `Save Recipe` to [save the recipe](/docs/guides/recipes/storing-recipes) locally
|
||||
- Click `Create Schedule` to [schedule the recipe](#schedule-recipe)
|
||||
1. While in the session you want to save as a recipe, click the <ChefHat className="inline" size={16} /> button at the bottom of the app
|
||||
2. In the dialog that opens, review and edit the recipe fields as needed:
|
||||
<RecipeFields />
|
||||
3. When you're finished, you can:
|
||||
- Click `Create Recipe` to save the recipe to your Recipe Library
|
||||
- Click `Create & Run Recipe` to save and immediately run the recipe in a new session
|
||||
</TabItem>
|
||||
<TabItem value="new" label="Template">
|
||||
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
|
||||
2. Click the `Recipes` button in the sidebar
|
||||
2. Click `Recipes` in the sidebar
|
||||
3. Click `Create Recipe`
|
||||
4. A dialog opens with placeholder content:
|
||||
- Provide a **title** and **description** for the recipe
|
||||
- Edit the **instructions** as needed
|
||||
- Provide an optional **initial prompt** to display in the chat box
|
||||
- Add or remove optional **activities** to display as buttons
|
||||
- Provide a **recipe name**
|
||||
- Choose to [save the recipe](/docs/guides/recipes/storing-recipes) with **global** or **directory** availability
|
||||
5. Click `Create Recipe`
|
||||
4. In the dialog that opens, fill in the recipe fields as needed:
|
||||
<RecipeFields />
|
||||
5. When you're finished, you can:
|
||||
- Copy the recipe link to share the recipe with others
|
||||
- Click `Save Recipe` to save the recipe to your Recipe Library
|
||||
- Click `Save & Run Recipe` to save and immediately run the recipe in a new session
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
@@ -191,23 +185,17 @@ You can turn your current goose session into a reusable recipe that includes the
|
||||
<TabItem value="ui" label="goose Desktop" default>
|
||||
|
||||
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
|
||||
2. Click `Recipes`
|
||||
2. Click `Recipes` in the sidebar
|
||||
3. Find the recipe you want to edit and click the <SquarePen className="inline" size={16} /> button
|
||||
4. In the dialog that appears, edit any of the following:
|
||||
- Title
|
||||
- Description
|
||||
- Instructions
|
||||
- Initial prompt
|
||||
- Activities
|
||||
- Parameters
|
||||
- Response schema
|
||||
4. When you're finished, you can:
|
||||
<RecipeFields />
|
||||
5. When you're finished, you can:
|
||||
- Copy the recipe link to share the recipe with others
|
||||
- Click `Save Recipe` to save your changes
|
||||
- Click `Create Schedule` to [schedule the recipe](#schedule-recipe)
|
||||
- Click `Save & Run Recipe` to save and immediately run the recipe in a new session
|
||||
|
||||
:::tip
|
||||
You can also access the edit dialog while using a recipe in a session: Just click the <Bot className="inline" size={16} /> button at the bottom of the app and select `View/Edit Recipe`.
|
||||
:::tip Edit In-Use Recipe
|
||||
You can also access the edit dialog while using a recipe in a session: Just click the <ChefHat className="inline" size={16} /> button at the bottom of the app. The button shows up after you've sent your first message.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
@@ -434,7 +422,7 @@ Create shortcuts to quickly run recipes in any goose chat session. Type a custom
|
||||
<Tabs groupId="interface">
|
||||
<TabItem value="ui" label="goose Desktop" default>
|
||||
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
|
||||
2. Click `Recipes`
|
||||
2. Click `Recipes` in the sidebar
|
||||
3. Find the recipe you want to edit and click the <Terminal className="inline" size={16} /> button
|
||||
4. In the modal that pops up, type your custom command (without the leading `/`) into the text box
|
||||
5. Click `Save`.
|
||||
@@ -538,7 +526,7 @@ When someone clicks the link, it will open goose Desktop with your recipe config
|
||||
You can share a recipe with Desktop or CLI users by sending the recipe file directly.
|
||||
|
||||
- Desktop users can [import the recipe](/docs/guides/recipes/storing-recipes#importing-recipes) (YAML only).
|
||||
- CLI users can run a YAML or JSON recipe using `goose run --recipe <FILE>` or open it directly in goose desktop with `goose recipe open <FILE>`. See the [CLI Commands guide](/docs/guides/goose-cli-commands#recipe) for details.
|
||||
- CLI users can run a YAML or JSON recipe using `goose run --recipe <FILE>` or open it directly in goose Desktop with `goose recipe open <FILE>`. See the [CLI Commands guide](/docs/guides/goose-cli-commands#recipe) for details.
|
||||
|
||||
## Schedule Recipe
|
||||
<Tabs groupId="interface">
|
||||
@@ -552,8 +540,8 @@ Automate goose recipes by running them on a schedule. When creating a schedule,
|
||||
**Schedule from Recipe Library:**
|
||||
|
||||
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
|
||||
2. Click `Recipes`
|
||||
3. Find the recipe you want to schedule and click the <Calendar className="inline" size={16} /> button
|
||||
2. Click `Recipes` in the sidebar
|
||||
3. Find the recipe you want to schedule and click the <Clock className="inline" size={16} /> button
|
||||
4. Click `Create Schedule`
|
||||
5. In the dialog that appears, configure the schedule. For **Source**, your recipe link is already provided.
|
||||
6. Click `Create Schedule`
|
||||
@@ -726,4 +714,4 @@ To protect your privacy and system integrity, goose excludes:
|
||||
This means others may need to supply their own credentials or memory context if the recipe depends on those elements.
|
||||
|
||||
## Learn More
|
||||
Check out the [Recipes](/docs/guides/recipes) guide for more docs, tools, and resources to help you master goose recipes.
|
||||
Check out the [Recipes](/docs/guides/recipes) guide for more docs, tools, and resources to help you master goose recipes.
|
||||
|
||||
@@ -6,7 +6,7 @@ sidebar_label: Saving Recipes
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import { PanelLeft, Bot } from 'lucide-react';
|
||||
import { PanelLeft, ChefHat } from 'lucide-react';
|
||||
|
||||
This guide covers storing, organizing, and finding goose recipes when you need to access them again later.
|
||||
|
||||
@@ -44,16 +44,15 @@ Before saving recipes, it's important to understand where they can be stored and
|
||||
|
||||
**Save New Recipe:**
|
||||
|
||||
1. To create a recipe from your chat session, see: [Create Recipe](/docs/guides/recipes/session-recipes#create-recipe)
|
||||
1. To create a recipe from your chat session, see [Create Recipe](/docs/guides/recipes/session-recipes#create-recipe)
|
||||
2. Once in the Recipe Editor, click `Save Recipe` to save it to your Recipe Library
|
||||
|
||||
**Save Modified Recipe:**
|
||||
|
||||
If you're already using a recipe and want to save a modified version:
|
||||
1. Click the <Bot className="inline" size={16}/> button with your current model at the bottom of the window
|
||||
2. Click `View Recipe`
|
||||
3. Make any desired edits to the description, instructions, or initial prompts
|
||||
5. Click `Save Recipe`
|
||||
1. Click the <ChefHat className="inline" size={16}/> button at the bottom of the app, which appears after sending your first message
|
||||
2. Make any desired edits to the instructions, prompt, or other fields
|
||||
3. Click `Save Recipe`
|
||||
|
||||
:::info
|
||||
When you modify and save a recipe with a new name, a new recipe and new link are generated. You can still run the original recipe from the recipe library, or using the original link. If you edit a recipe without changing its name, the version in the recipe library is updated, but you can still run the original recipe via link.
|
||||
|
||||
Reference in New Issue
Block a user