From a82457c625f44fba71e4b2aadf08f7899046bea2 Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 01:27:36 -0400 Subject: [PATCH 01/11] docs: add comprehensive documentation for `goose recipe open` command - Add detailed documentation in CLI commands guide with examples and usage - Add brief mentions in recipe guides with links to avoid repetition - Document command functionality: opens recipes in goose desktop via goose:// protocol - Include use cases: CLI-to-desktop workflow, preview, and sharing - Follow lowercase 'goose desktop' branding convention --- .../docs/guides/goose-cli-commands.md | 31 +++++++++++++++++-- .../docs/guides/recipes/recipe-reference.md | 7 ++++- .../docs/guides/recipes/session-recipes.md | 4 +++ .../docs/guides/recipes/storing-recipes.md | 2 +- 4 files changed, 39 insertions(+), 5 deletions(-) diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md index 80e7d85b6466..9ee3b5cc841b 100644 --- a/documentation/docs/guides/goose-cli-commands.md +++ b/documentation/docs/guides/goose-cli-commands.md @@ -267,11 +267,17 @@ goose bench ...etc. --- #### recipe -Used to validate recipe files and manage recipe sharing. +Used to validate recipe files, manage recipe sharing, and open recipes in Goose Desktop. **Commands:** - `validate `: Validate a recipe file - `deeplink `: Generate a shareable link for a recipe file +- `open `: Open a recipe file directly in goose desktop +- `list [options]`: List all available recipes + +**Options (for list command):** +- **`--format `**: Output format (`text` or `json`). Default is `text` +- **`-v, --verbose`**: Show detailed information including recipe descriptions **Usage:** ```bash @@ -280,13 +286,32 @@ goose recipe # Validate a recipe file goose recipe validate my-recipe.yaml -# Generate a shareable link +# Generate a shareable deeplink goose recipe deeplink my-recipe.yaml +# Open a recipe in goose desktop +goose recipe open my-recipe.yaml + +# Open a recipe by name (from configured recipe sources) +goose recipe open daily-standup + +# List all available recipes +goose recipe list + +# List recipes with descriptions +goose recipe list --verbose + +# List recipes in JSON format +goose recipe list --format json + # Get help about recipe commands goose recipe help ``` +:::tip +The `open` command creates a `goose://` protocol URL and opens it with your system's default handler. If goose desktop is installed and registered as the protocol handler, the recipe will open directly in a new chat window. +::: + --- #### schedule @@ -490,7 +515,7 @@ The `/t` command controls the syntax highlighting theme for markdown content in :::info Syntax highlighting styles only affect the font, not the overall terminal interface. The `light` and `dark` themes have subtle differences in font color and weight. -The Goose CLI theme is independent from the Goose Desktop theme. +The goose CLI theme is independent from the goose desktop theme. ::: **Examples:** diff --git a/documentation/docs/guides/recipes/recipe-reference.md b/documentation/docs/guides/recipes/recipe-reference.md index 3704423ab73d..5e05b20654ba 100644 --- a/documentation/docs/guides/recipes/recipe-reference.md +++ b/documentation/docs/guides/recipes/recipe-reference.md @@ -16,7 +16,12 @@ Files should be named either: - `recipe.yaml`/`recipe.json` - `.yaml`/`.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. +After creating recipe files, you can use [`goose` CLI commands](/docs/guides/goose-cli-commands) to: +- Run recipes (`goose run --recipe `) +- Validate recipes (`goose recipe validate `) +- Generate shareable deeplinks (`goose recipe deeplink `) +- Open recipes in goose desktop (`goose recipe open `) +- List available recipes (`goose recipe list`) ### CLI and Desktop Formats diff --git a/documentation/docs/guides/recipes/session-recipes.md b/documentation/docs/guides/recipes/session-recipes.md index f9effb546e1c..50f24553b14a 100644 --- a/documentation/docs/guides/recipes/session-recipes.md +++ b/documentation/docs/guides/recipes/session-recipes.md @@ -420,6 +420,10 @@ You can turn your current Goose session into a reusable recipe that includes the - No data is shared between users - Your session won't affect the original recipe creator's session - The CLI can prompt users for required [extension secrets](/docs/guides/recipes/recipe-reference#extension-secrets) + ::: + + :::tip Opening Recipes in Desktop + You can also open recipe files directly in goose desktop using `goose recipe open `. See the [CLI Commands guide](/docs/guides/goose-cli-commands#recipe) for details. ::: diff --git a/documentation/docs/guides/recipes/storing-recipes.md b/documentation/docs/guides/recipes/storing-recipes.md index f9677501badc..08ff346256ea 100644 --- a/documentation/docs/guides/recipes/storing-recipes.md +++ b/documentation/docs/guides/recipes/storing-recipes.md @@ -151,7 +151,7 @@ Set up [custom recipe paths](/docs/guides/recipes/session-recipes#configure-reci -Once you've located your recipe file, [run the recipe](/docs/guides/recipes/session-recipes#run-a-recipe). +Once you've located your recipe file, [run the recipe](/docs/guides/recipes/session-recipes#run-a-recipe) or [open it in goose desktop](/docs/guides/goose-cli-commands#recipe). :::tip Format Compatibility The CLI can run recipes saved from Goose Desktop without any conversion. Both CLI-created and Desktop-saved recipes work with all recipe commands. From 48769e07074a22d78668b558bf4def9cd8d048d9 Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 01:44:01 -0400 Subject: [PATCH 02/11] Remove references to 'goose recipe list' command --- documentation/docs/guides/goose-cli-commands.md | 14 -------------- .../docs/guides/recipes/recipe-reference.md | 1 - 2 files changed, 15 deletions(-) diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md index 9ee3b5cc841b..1b0f6dd8494f 100644 --- a/documentation/docs/guides/goose-cli-commands.md +++ b/documentation/docs/guides/goose-cli-commands.md @@ -273,11 +273,6 @@ Used to validate recipe files, manage recipe sharing, and open recipes in Goose - `validate `: Validate a recipe file - `deeplink `: Generate a shareable link for a recipe file - `open `: Open a recipe file directly in goose desktop -- `list [options]`: List all available recipes - -**Options (for list command):** -- **`--format `**: Output format (`text` or `json`). Default is `text` -- **`-v, --verbose`**: Show detailed information including recipe descriptions **Usage:** ```bash @@ -295,15 +290,6 @@ goose recipe open my-recipe.yaml # Open a recipe by name (from configured recipe sources) goose recipe open daily-standup -# List all available recipes -goose recipe list - -# List recipes with descriptions -goose recipe list --verbose - -# List recipes in JSON format -goose recipe list --format json - # Get help about recipe commands goose recipe help ``` diff --git a/documentation/docs/guides/recipes/recipe-reference.md b/documentation/docs/guides/recipes/recipe-reference.md index 5e05b20654ba..a8160e78825d 100644 --- a/documentation/docs/guides/recipes/recipe-reference.md +++ b/documentation/docs/guides/recipes/recipe-reference.md @@ -21,7 +21,6 @@ After creating recipe files, you can use [`goose` CLI commands](/docs/guides/goo - Validate recipes (`goose recipe validate `) - Generate shareable deeplinks (`goose recipe deeplink `) - Open recipes in goose desktop (`goose recipe open `) -- List available recipes (`goose recipe list`) ### CLI and Desktop Formats From fef0999283e1a89c0c34c1ebf0a1f2e52331c46f Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 01:50:22 -0400 Subject: [PATCH 03/11] Move recipe open command info to Share via Recipe File section --- documentation/docs/guides/recipes/session-recipes.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/documentation/docs/guides/recipes/session-recipes.md b/documentation/docs/guides/recipes/session-recipes.md index 50f24553b14a..5b829f8d3a76 100644 --- a/documentation/docs/guides/recipes/session-recipes.md +++ b/documentation/docs/guides/recipes/session-recipes.md @@ -420,10 +420,6 @@ You can turn your current Goose session into a reusable recipe that includes the - No data is shared between users - Your session won't affect the original recipe creator's session - The CLI can prompt users for required [extension secrets](/docs/guides/recipes/recipe-reference#extension-secrets) - ::: - - :::tip Opening Recipes in Desktop - You can also open recipe files directly in goose desktop using `goose recipe open `. See the [CLI Commands guide](/docs/guides/goose-cli-commands#recipe) for details. ::: @@ -491,7 +487,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 ` +- CLI users can run a YAML or JSON recipe using `goose run --recipe ` or open it directly in goose desktop with `goose recipe open `. See the [CLI Commands guide](/docs/guides/goose-cli-commands#recipe) for details. ## Schedule Recipe From d4e81b8e7f347b84b9fc50b2a8005d14f4ca8f63 Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 01:57:11 -0400 Subject: [PATCH 04/11] Remove command repetition from recipe reference guide Make CLI commands guide the single source of truth for command details. Recipe reference guide now focuses on technical specifications only. --- documentation/docs/guides/recipes/recipe-reference.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/documentation/docs/guides/recipes/recipe-reference.md b/documentation/docs/guides/recipes/recipe-reference.md index a8160e78825d..f25dc1a9f7cb 100644 --- a/documentation/docs/guides/recipes/recipe-reference.md +++ b/documentation/docs/guides/recipes/recipe-reference.md @@ -16,11 +16,7 @@ Files should be named either: - `recipe.yaml`/`recipe.json` - `.yaml`/`.json` -After creating recipe files, you can use [`goose` CLI commands](/docs/guides/goose-cli-commands) to: -- Run recipes (`goose run --recipe `) -- Validate recipes (`goose recipe validate `) -- Generate shareable deeplinks (`goose recipe deeplink `) -- Open recipes in goose desktop (`goose recipe open `) +After creating recipe files, you can use the [`goose recipe` commands](/docs/guides/goose-cli-commands#recipe) to validate, share, and open your recipes. ### CLI and Desktop Formats From 1029ba91181524930576039fce735c7afbe17c02 Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 01:58:51 -0400 Subject: [PATCH 05/11] Use 'subcommands' instead of 'commands' for goose recipe reference --- documentation/docs/guides/recipes/recipe-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/guides/recipes/recipe-reference.md b/documentation/docs/guides/recipes/recipe-reference.md index f25dc1a9f7cb..cc2567708b59 100644 --- a/documentation/docs/guides/recipes/recipe-reference.md +++ b/documentation/docs/guides/recipes/recipe-reference.md @@ -16,7 +16,7 @@ Files should be named either: - `recipe.yaml`/`recipe.json` - `.yaml`/`.json` -After creating recipe files, you can use the [`goose recipe` commands](/docs/guides/goose-cli-commands#recipe) to validate, share, and open your recipes. +After creating recipe files, you can use the [`goose recipe` subcommands](/docs/guides/goose-cli-commands#recipe) to validate, share, and open your recipes. ### CLI and Desktop Formats From 235f4b27bfba78cb028a4ebe2ec329bfdf2ac006 Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 01:59:51 -0400 Subject: [PATCH 06/11] Remove tip about goose:// protocol URL from recipe open command --- documentation/docs/guides/goose-cli-commands.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md index 1b0f6dd8494f..9e92aa10dba8 100644 --- a/documentation/docs/guides/goose-cli-commands.md +++ b/documentation/docs/guides/goose-cli-commands.md @@ -294,10 +294,6 @@ goose recipe open daily-standup goose recipe help ``` -:::tip -The `open` command creates a `goose://` protocol URL and opens it with your system's default handler. If goose desktop is installed and registered as the protocol handler, the recipe will open directly in a new chat window. -::: - --- #### schedule From 911350174011a7c69ce1ac0e1126b0121f00f8b1 Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 02:00:37 -0400 Subject: [PATCH 07/11] Revert capitalization change unrelated to recipe open command PR --- documentation/docs/guides/goose-cli-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md index 9e92aa10dba8..0580887379db 100644 --- a/documentation/docs/guides/goose-cli-commands.md +++ b/documentation/docs/guides/goose-cli-commands.md @@ -497,7 +497,7 @@ The `/t` command controls the syntax highlighting theme for markdown content in :::info Syntax highlighting styles only affect the font, not the overall terminal interface. The `light` and `dark` themes have subtle differences in font color and weight. -The goose CLI theme is independent from the goose desktop theme. +The Goose CLI theme is independent from the Goose Desktop theme. ::: **Examples:** From a620b84d26e838a9357c3b5006da212da43b55d8 Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 02:03:43 -0400 Subject: [PATCH 08/11] Use lowercase 'goose desktop' in recipe command description --- documentation/docs/guides/goose-cli-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md index 0580887379db..8d12792ce224 100644 --- a/documentation/docs/guides/goose-cli-commands.md +++ b/documentation/docs/guides/goose-cli-commands.md @@ -267,7 +267,7 @@ goose bench ...etc. --- #### recipe -Used to validate recipe files, manage recipe sharing, and open recipes in Goose Desktop. +Used to validate recipe files, manage recipe sharing, and open recipes in goose desktop. **Commands:** - `validate `: Validate a recipe file From 2b95fa177a2dbd67abea4bde5db15e30cca4540a Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 02:05:12 -0400 Subject: [PATCH 09/11] Change comment back to 'shareable link' instead of 'shareable deeplink' --- documentation/docs/guides/goose-cli-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md index 8d12792ce224..d997b7d33d2e 100644 --- a/documentation/docs/guides/goose-cli-commands.md +++ b/documentation/docs/guides/goose-cli-commands.md @@ -281,7 +281,7 @@ goose recipe # Validate a recipe file goose recipe validate my-recipe.yaml -# Generate a shareable deeplink +# Generate a shareable link goose recipe deeplink my-recipe.yaml # Open a recipe in goose desktop From 1b0ca4ff3082f6beba26da0ac20052cb5cba1f1c Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 02:10:23 -0400 Subject: [PATCH 10/11] Simplify recipe open by name comment - remove verbose parenthetical --- documentation/docs/guides/goose-cli-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md index d997b7d33d2e..9360f2842b36 100644 --- a/documentation/docs/guides/goose-cli-commands.md +++ b/documentation/docs/guides/goose-cli-commands.md @@ -287,7 +287,7 @@ goose recipe deeplink my-recipe.yaml # Open a recipe in goose desktop goose recipe open my-recipe.yaml -# Open a recipe by name (from configured recipe sources) +# Open a recipe by name goose recipe open daily-standup # Get help about recipe commands From d9d940b938c46247b60abc3b8a94a5f10236ffbd Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Mon, 20 Oct 2025 02:13:36 -0400 Subject: [PATCH 11/11] Change recipe example from 'daily-standup' to 'my-recipe' for clarity --- documentation/docs/guides/goose-cli-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md index 9360f2842b36..3f0810c74cec 100644 --- a/documentation/docs/guides/goose-cli-commands.md +++ b/documentation/docs/guides/goose-cli-commands.md @@ -288,7 +288,7 @@ goose recipe deeplink my-recipe.yaml goose recipe open my-recipe.yaml # Open a recipe by name -goose recipe open daily-standup +goose recipe open my-recipe # Get help about recipe commands goose recipe help