aljaz/goose
1
0
Fork 0
mirror of https://github.com/aljazceru/goose.git synced 2025-12-18 14:44:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: recipe parameters in desktop (#3326)

Browse Source
This commit is contained in:
dianed-square
2025-07-09 15:38:34 -07:00
committed by GitHub
parent c81cf6fb3a
commit 1e6aa15649
2 changed files with 26 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/docs/guides/recipes/recipe-reference.md
View File

@@ -64,6 +64,8 @@ Each parameter in the `parameters` array has the following structure:
- `optional`: Can be omitted if a default value is specified - `optional`: Can be omitted if a default value is specified
- `user_prompt`: Will interactively prompt the user for input if not provided - `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 :::important
- Optional parameters MUST have a default value specified - Optional parameters MUST have a default value specified
- Required parameters cannot have default values - Required parameters cannot have default values

23
documentation/docs/guides/recipes/session-recipes.md
View File

@@ -186,19 +186,32 @@ You can turn your current Goose session into a reusable recipe that includes the
<Tabs groupId="interface"> <Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default> <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** - **Direct Link**
- Click a recipe link shared with you - Click a recipe link shared with you
- The recipe will automatically open in Goose Desktop - The recipe will automatically open in Goose Desktop
2. **Manual URL Entry** - **Manual URL Entry**
- Copy a recipe URL - Copy a recipe URL
- Paste it into your browser's address bar - Paste it into your browser's address bar
- You will see a prompt to "Open Goose" - You will see a prompt to "Open Goose"
- Goose Desktop will open with the recipe - 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 - Each person gets their own private session
- No data is shared between users - No data is shared between users
- Your session won't affect the original recipe creator's session - 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
</TabItem> </TabItem>
</Tabs> </Tabs>
:::note Privacy & Isolation :::info Privacy & Isolation
- Each person gets their own private session - Each person gets their own private session
- No data is shared between users - No data is shared between users
- Your session won't affect the original recipe creator's session - Your session won't affect the original recipe creator's session