Skip to content

CLI Commands for State Management #573

@Sankara-Jefferson

Description

@Sankara-Jefferson

CLI Commands for State Management
Current State:
Currently, users and operators have no command-line tools to directly view, export, or recover deal state changes. All interactions must be done through the API or database, which can be cumbersome and less accessible for many operational tasks.

Why This Is Beneficial:
Introducing CLI commands will:

  • Allow users and operators to quickly inspect the state change history of any deal without writing custom scripts or database queries.
  • Enable easy export of state change data for reporting, backup, or analysis in common formats like CSV or JSON.
  • Provide a straightforward way to manually trigger state recovery or repair operations, which is essential for troubleshooting and operational resilience.
  • Improve overall usability, making state management accessible to a wider range of users, including those who prefer or require command-line workflows.
  • Reduce operational friction and speed up incident response.

Acceptance Criteria:

  • Add CLI commands to view state changes for specific deals or filtered sets of deals.
  • Support exporting state change history to files in standard formats (e.g., CSV, JSON).
  • Implement CLI commands that allow users to manually trigger state recovery or repair for deals with missing or inconsistent state changes.
  • Add or update unit tests for all new logic.
  • Add or update integration tests covering end-to-end scenarios.
  • Update documentation (user guides, CLI help, API docs) to reflect new features and usage.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

No status

Relationships

None yet

Development

No branches or pull requests

Issue actions