Skip to content

XMover: Rename --auto-execute flag to --confirm for better UX #540

@coderabbitai

Description

@coderabbitai

Summary

The current --auto-execute flag in XMover's recommend command could be renamed to --confirm for better user experience and clarity.

Current Implementation

In cratedb_toolkit/admin/xmover/tune/recommend.py, the --auto-execute flag is used to automatically proceed with executing shard relocation recommendations without manual confirmation.

Suggested Improvement

Rename --auto-execute to --confirm because:

  • --confirm is more intuitive and commonly used in CLI tools
  • It better describes the action: confirming to proceed with the recommendations
  • Reduces potential confusion about what "auto-execute" means in this context

Related

Implementation Notes

This change would affect:

  • CLI argument definition in the recommend command
  • Documentation and help text
  • Any usage examples in docs

/cc @amotl

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions