diff --git a/documentation/docs/guides/recipes/recipe-reference.md b/documentation/docs/guides/recipes/recipe-reference.md index b53699dd304e..4088368d6d30 100644 --- a/documentation/docs/guides/recipes/recipe-reference.md +++ b/documentation/docs/guides/recipes/recipe-reference.md @@ -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 diff --git a/documentation/docs/guides/recipes/session-recipes.md b/documentation/docs/guides/recipes/session-recipes.md index 3425ad3f66c3..c1d6757c05a5 100644 --- a/documentation/docs/guides/recipes/session-recipes.md +++ b/documentation/docs/guides/recipes/session-recipes.md @@ -186,19 +186,32 @@ You can turn your current Goose session into a reusable recipe that includes the - 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 @@ -364,7 +377,7 @@ You can turn your current Goose session into a reusable recipe that includes the - :::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