Standardize CLI argument flags and update documentation
This PR establishes consistent flag naming patterns across all Goose CLI commands, eliminating confusion around --id vs --session-id, conflicting short flags, and mismatched documentation. Previously, session commands mixed --id and --session-id, the --name flag had a misleading id alias, and schedule commands lacked short flags entirely.
Before this change, users encountered inconsistent flag names across commands, making it unclear when to use --id versus --session-id. The Identifier struct's --name flag incorrectly aliased to id, and the -p short flag conflicted between path and working_dir usage. Schedule commands used generic --id, and documentation showed flags that didn't match the actual implementation.
- Updated Identifier struct to use
alias = "id"on--session-id(instead of on--name), removed-pshort flag from legacy--pathparameter, and kept-nfor name - Changed
SessionCommand::Removeto use--session-idand separate--nameflag, updatinghandle_session_removeto accept three distinct parameters - Renamed all schedule command flags from
--idto--schedule-idwith-ishort flag, updating handlers inschedule.rs - Fixed
SessionCommand::Listworking_dir to use-wwith-pas backward-compatible alias, and SessionCommand::Diagnosticssession-id to use-i` - Updated help strings to clarify "recurring scheduled job" for schedule-id and fixed session
--resumehelp to reference--session-idinstead of--path - Marked ServicesStatus and ServicesStop commands as
[Deprecated] - Added "Flag Naming Conventions" section to documentation and updated all examples to reflect standardized patterns
Type of Change
- [ ] Feature
- [ ] Bug fix
- [x] Refactor / Code quality
- [ ] Performance improvement
- [ ] Documentation
- [ ] Tests
- [ ] Security fix
- [ ] Build / Release
- [ ] Other (specify below)
PR Preview Action v1.6.0 :---: Preview removed because the pull request was closed. 2025-11-06 23:13 UTC
Thanks @wpfleger96! Would you also be able to update the feature docs that reference the changed flags? Specifically:
- guides/recipes/session-recipes.md): --id → --schedule-id
- troubleshooting/diagnostics-and-reporting.md: --id → --session-id
It would be better to show the new canonical flag names even though the old flags still work via aliases.
@dianed-square great catch thank you! just updated those feature docs and a couple more places I found while testing