Skip to content

docs: recipe parameters in desktop #3326

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 1 commit into from
Jul 9, 2025
Merged

docs: recipe parameters in desktop #3326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions documentation/docs/guides/recipes/recipe-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ Each parameter in the `parameters` array has the following structure:
- `optional`: Can be omitted if a default value is specified
- `user_prompt`: Will interactively prompt the user for input if not provided

The `required` and `optional` parameters work best for recipes opened in Goose Desktop. If a value isn't provided for a `user_prompt` parameter, the parameter won't be substituted and may appear as literal `{{ parameter_name }}` text in the recipe output.

:::important
- Optional parameters MUST have a default value specified
- Required parameters cannot have default values
Expand Down
35 changes: 24 additions & 11 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 @@ -186,19 +186,32 @@ You can turn your current Goose session into a reusable recipe that includes the
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>

There are two ways to use a recipe in Goose Desktop:
1. Open the recipe using a direct link or manual URL entry:

1. **Direct Link**
- Click a recipe link shared with you
- The recipe will automatically open in Goose Desktop
- **Direct Link**
- Click a recipe link shared with you
- The recipe will automatically open in Goose Desktop

2. **Manual URL Entry**
- Copy a recipe URL
- Paste it into your browser's address bar
- You will see a prompt to "Open Goose"
- Goose Desktop will open with the recipe
- **Manual URL Entry**
- Copy a recipe URL
- Paste it into your browser's address bar
- You will see a prompt to "Open Goose"
- Goose Desktop will open with the recipe

:::note Privacy & Isolation
2. If the recipe contains parameters, enter your values in the **Recipe Parameters** dialog and click **Start Recipe**.

Parameters are dynamic values used in the recipe:

- **Required parameters** are marked with red asterisks (*)
- **Optional parameters** show default values that can be changed

3. To run the recipe, click an activity bubble or send the prompt.

:::info Parameter Creation In Goose CLI Only
You can enter parameter values to use in a recipe, but you cannot add parameters to a recipe in Goose Desktop. Parameters can only be defined in recipes created via the CLI.
:::

:::info Privacy & Isolation
- Each person gets their own private session
- No data is shared between users
- Your session won't affect the original recipe creator's session
Expand Down Expand Up @@ -364,7 +377,7 @@ You can turn your current Goose session into a reusable recipe that includes the

</TabItem>
</Tabs>
:::note Privacy & Isolation
:::info Privacy & Isolation
- Each person gets their own private session
- No data is shared between users
- Your session won't affect the original recipe creator's session
Expand Down