docs: param option for recipe deeplink/open #6206
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the CLI documentation to accurately reflect the current implementation of recipe commands. The documentation now correctly shows that -p is the short alias for --param (not --path), and documents the --param flag for both recipe deeplink and recipe open commands.
Key Changes
- Removed the incorrect
-pshort alias from--pathdocumentation (the code never had this alias) - Added
-p, --paramdocumentation forrecipe deeplinkandrecipe opencommands - Added usage examples demonstrating the
--paramflag
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| documentation/docs/guides/goose-cli-commands.md | Updated flag reference table and recipe command documentation to reflect -p as alias for --param, added usage examples |
| documentation/docs/guides/recipes/session-recipes.md | Added example showing how to use --param with recipe deeplink command |
The documentation changes are accurate and consistent with the actual CLI implementation in crates/goose-cli/src/cli.rs. All examples are technically correct and the changes improve documentation clarity.
Contributor
|
blackgirlbytes
approved these changes
Dec 19, 2025
wpfleger96
added a commit
that referenced
this pull request
Dec 23, 2025
* main: (155 commits) remove Tool Selection Strategy preview (#6250) fix(cli): correct bash syntax in terminal integration functions (#6181) fix : opening a session to view it modifies session history order in desktop (#6156) test: fix recipe and audio tests to avoid side effects (#6231) chore: Update gemini versions in test_providers.sh (#6246) feat: option to stream json - jsonl really (#6228) feat: add mcp app renderer (#6095) docs: update skills extension to support .agents/skills directories (#6199) Add YouTube short to Chrome DevTools MCP tutorial (#6244) docs: Caveats for privacy information in logs documentation (#6218) move goose issue solver to opus (#6233) feat: improved UX for tool calls via execute_code (#6205) Blog: Code Mode Doesn't Replace MCP (#6227) fix: prevent keychain requests during cargo test (#6219) test: fix test_max_turns_limit slow execution and wrong message type (#6221) Skills vs MCP blog (#6220) Add blog post: Does Your AI Agent Need a Plan? (#6209) fix(ui): enable MCP UI to send a prompt message when an element is clicked (#6207) docs: param option for recipe deeplink/open (#6206) docs: edit in place or fork session (#6203) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR documents the
--paramflag forrecipe deeplinkandrecipe openand removes the outdated-palias for--path.Documentation updates:
documentation/docs/guides/goose-cli-commands.md:-p, --param <KEY=VALUE>option-palias for--pathdocumentation/docs/guides/recipes/session-recipes.md:--paramexampleType of Change
AI Assistance
Testing
Manual testing