Skip to content

docs: add generator option to create recipe #3182

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
dianed-square merged 4 commits into from
Jun 30, 2025
Merged

docs: add generator option to create recipe #3182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a8e707c
add generator option to create recipe
dianed-square Jun 30, 2025
dfd436b
stray s
dianed-square Jun 30, 2025
8790563
Merge branch 'main' into docs/generator-create-recipe
dianed-square Jun 30, 2025
88fef67
Update documentation/docs/guides/recipes/session-recipes.md
dianed-square Jun 30, 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
4 changes: 3 additions & 1 deletion documentation/docs/guides/recipes/recipe-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Files should be named either:
- `recipe.yaml`/`recipe.json`
- `<recipe_name>.yaml`/`<recipe_name>.json`

After creating recipe files, you can use [`goose` CLI commands](/docs/guides/goose-cli-commands) to run or validate the files and to manage recipe sharing.

## Recipe Structure

### Required Fields
Expand All @@ -31,7 +33,7 @@ Files should be named either:
| Field | Type | Description |
|-------|------|-------------|
| `instructions` | String | Template instructions that can include parameter substitutions |
| `prompt` | String | A template prompt that can include parameter substitutions |
| `prompt` | String | A template prompt that can include parameter substitutions; required in headless (non-interactive) mode |
Copy link
Contributor Author

@dianed-square dianed-square Jun 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

per testing and Goose, added this note in a couple places

| `parameters` | Array | List of parameter definitions |
| `extensions` | Array | List of extension configurations |

Expand Down
36 changes: 29 additions & 7 deletions documentation/docs/guides/recipes/session-recipes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,17 @@ You can turn your current Goose session into a reusable recipe that includes the
<Tabs>
<TabItem value="ui" label="Goose Desktop" default>
:::warning
You cannot create a recipe from an existing recipe session - the "Make recipe from this session" option will be disabled.
You cannot create a recipe from an existing recipe session, but you can view or [edit the recipe](#edit-recipe).
:::

1. While in the session you want to save as a recipe, click the menu icon **⋮** in the top right corner
1. While in the session you want to save as a recipe, click the gear icon `⚙️` in the top right corner
2. Select **Make recipe from this session**
3. In the dialog that appears:
- Name the recipe
- Provide a description
- Some **activities** will be automatically generated. Add or remove as needed.
- A set of **instructions** will also be automatically generated. Review and edit as needed.
- Provide a **title** for the recipe
- Provide a **description**
- A set of **instructions** will also be automatically generated. Review and edit as needed.
- Provide an optional initial **prompt** to display in the chat box.
- Some **activities** will be automatically generated. Add or remove as needed.
4. Copy the recipe URL and use it however you like (e.g., share it with teammates, drop it in documentation, or keep it for yourself)

</TabItem>
Expand Down Expand Up @@ -128,6 +129,8 @@ You can turn your current Goose session into a reusable recipe that includes the
```
</details>

See the [Recipe Reference Guide](/docs/guides/recipes/recipe-reference) for more information about recipe fields.

### Validate Recipe

[Exit the session](/docs/guides/managing-goose-sessions#exit-session) and run:
Expand All @@ -151,13 +154,32 @@ Validation ensures that:
```

</TabItem>


<TabItem value="generator" label="Recipe Generator">
Use the online [Recipe Generator](https://block.github.io/goose/recipe-generator) tool to create a recipe. First choose your preferred format:

- **URL Format**: Generates a shareable link that opens a session in the Goose Desktop app
- **YAML Format**: Generates YAML content that you can save to file and then run in the Goose CLI app

Then fill out the recipe form by providing:
- A **title** for the recipe
- A **description**
- A set of **instructions** for the recipe.
- An optional inital **prompt**:
- In the Desktop app, the prompt displays in the chat box.
- In the CLI app, the prompt provides the initial message to run. Note that a prompt is required to run the recipe in headless (non-interactive) mode.
- A set of optional **activities** to display in the Desktop app.
- YAML format only: Optional **author** contact information and **extensions** the recipe usess.

</TabItem>
</Tabs>

## Edit Recipe
<Tabs>
<TabItem value="ui" label="Goose Desktop" default>

1. While in the session created from a recipe, click the menu icon **⋮** in the top right corner
1. While in the session created from a recipe, click the gear icon `⚙️` in the top right corner
2. Select **View recipe**
3. In the dialog that appears, you can edit the:
- Title
Expand Down
Loading