From e84d7dc3fc1dfcd6ed0d386b3980a14ec52a1de3 Mon Sep 17 00:00:00 2001
From: dianed-square <73617011+dianed-square@users.noreply.github.com>
Date: Fri, 19 Dec 2025 14:06:00 -0800
Subject: [PATCH] docs: param option for recipe deeplink/open (#6206)

---
 .../docs/guides/goose-cli-commands.md         | 20 +++++++++++++------
 .../docs/guides/recipes/session-recipes.md    |  5 +++++
 2 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md
index 894446f5..d7386d53 100644
--- a/documentation/docs/guides/goose-cli-commands.md
+++ b/documentation/docs/guides/goose-cli-commands.md
@@ -14,7 +14,7 @@ goose CLI follows consistent patterns for flag naming to make commands intuitive
 - **`--session-id`**: Used for session identifiers (e.g., `20251108_1`)
 - **`--schedule-id`**: Used for schedule job identifiers (e.g., `daily-report`)
 - **`-n, --name`**: Used for human-readable names
-- **`-p, --path`**: Used for file paths (legacy support)
+- **`--path`**: Used for file paths (legacy support)
 - **`-o, --output`**: Used for output file paths
 - **`-r, --resume` or `-r, --regex`**: Context-dependent (resume for sessions, regex for filters)
 - **`-v, --verbose`**: Used for verbose output
@@ -101,7 +101,7 @@ Start or resume interactive chat sessions.
 **Basic Options:**
 - **`--session-id <session_id>`**: Specify a session by its ID (e.g., '20251108_1')
 - **`-n, --name <name>`**: Give the session a name
-- **`-p, --path <path>`**: Legacy parameter for specifying session by file path
+- **`--path <path>`**: Legacy parameter for specifying session by file path
 - **`-r, --resume`**: Resume a previous session
 - **`--history`**: Show previous messages when resuming a session
 - **`--debug`**: Enable debug mode to output complete tool responses, detailed parameter values, and full file paths
@@ -122,8 +122,8 @@ goose session -n my-project
 # Resume a previous session
 goose session --resume -n my-project
 goose session --resume --session-id 20251108_2
-goose session --resume -p ./session.json    # exported session
-goose session --resume -p ./session.jsonl   # legacy session storage
+goose session --resume --path ./session.json    # exported session
+goose session --resume --path ./session.jsonl   # legacy session storage
 
 # Start with extensions
 goose session --with-extension "npx -y @modelcontextprotocol/server-memory"
@@ -236,7 +236,7 @@ goose session export --session-id 20251108_4 --format json
 goose session export -n my-session --format yaml
 
 # Export session by path (legacy)
-goose session export -p ./my-session.jsonl -o exported.md
+goose session export --path ./my-session.jsonl -o exported.md
 ```
 
 ---
@@ -298,7 +298,7 @@ Execute commands from an instruction file or stdin. Check out the [full guide](/
 - **`-s, --interactive`**: Continue in interactive mode after processing initial input
 - **`-n, --name <name>`**: Name for this run session (e.g. `daily-tasks`)
 - **`-r, --resume`**: Resume from a previous run
-- **`-p, --path <PATH>`**: Path for this run session (e.g. `./playground.jsonl`). Used for legacy file-based session storage.
+- **`--path <PATH>`**: Path for this run session (e.g. `./playground.jsonl`). Used for legacy file-based session storage.
 - **`--no-session`**: Run goose commands without creating or storing a session file
 
 **Extension Options:**
@@ -365,10 +365,12 @@ Used to validate recipe files, manage recipe sharing, list available recipes, an
 
 **Commands:**
 - **`deeplink <RECIPE_NAME>`**: Generate a shareable link for a recipe file
+  - **`-p, --param <KEY=VALUE>`**: Pre-fill recipe parameter (can be specified multiple times)
 - **`list [OPTIONS]`**: List all available recipes from local directories and configured GitHub repositories
   - **`--format <FORMAT>`**: Output format (`text` or `json`). Default is `text`
   - **`-v, --verbose`**: Show verbose information including recipe titles and full file paths
 - **`open <RECIPE_NAME>`**: Open a recipe file directly in goose desktop
+  - **`-p, --param <KEY=VALUE>`**: Pre-fill recipe parameter (can be specified multiple times)
 - **`validate <RECIPE_NAME>`**: Validate a recipe file
 
 **Usage:**
@@ -376,6 +378,9 @@ Used to validate recipe files, manage recipe sharing, list available recipes, an
 # Generate a shareable link
 goose recipe deeplink my-recipe.yaml
 
+# Generate a deeplink and provide parameter values
+goose recipe deeplink my-recipe.yaml -p environment=production -p region=us-west-2
+
 # List all available recipes
 goose recipe list
 
@@ -391,6 +396,9 @@ goose recipe open my-recipe.yaml
 # Open a recipe by name
 goose recipe open my-recipe
 
+# Open a recipe and provide parameter value
+goose recipe open my-recipe --param name=myproject
+
 # Validate a recipe file
 goose recipe validate my-recipe.yaml
 
diff --git a/documentation/docs/guides/recipes/session-recipes.md b/documentation/docs/guides/recipes/session-recipes.md
index df925def..2ce95c09 100644
--- a/documentation/docs/guides/recipes/session-recipes.md
+++ b/documentation/docs/guides/recipes/session-recipes.md
@@ -517,6 +517,11 @@ You can share a recipe with Desktop users via a recipe link.
     ```sh
     goose recipe deeplink <FILE>
     ```
+
+    You can also provide parameter values to pre-fill the `Recipe Parameters` dialog:
+    ```sh
+    goose recipe deeplink <FILE> --param key1=value1 --param key2=value2
+    ```
   </TabItem>
 </Tabs>