Skip to content

Improve CLI Commands for Video Extraction #6

@thisguymartin

Description

@thisguymartin

Description:

Issue:
Currently, our CLI commands for video extraction are not as clear and user-friendly as they should be. Users can get confused when distinguishing between commands like python main.py video extract-audio-aws and python main.py video extract-audio.

Problem:
The issue arises from the similarity in command names, which can lead to confusion and potential errors when users intend to perform specific video extraction tasks. It's essential to have clear and distinct command names to enhance the user experience and avoid misunderstandings.

Expected Behavior:
The expected behavior should be a more intuitive and user-friendly CLI command structure for video extraction. Users should be able to understand and use the commands without confusion.

Proposed Solution:
To address this issue, we should revamp our CLI command structure for video extraction to make it more clear and distinguishable. Here's a proposed solution:

  1. Current Command: python main.py video extract-audio-aws

    • Proposed Command: python main.py video extract-audio-aws
  2. Current Command: python main.py video extract-audio

    • Proposed Command: python main.py video extract-audio-local

By adding the "local" suffix to the second command, we make it clear that it pertains to local extraction, and users can easily differentiate it from AWS-based extraction. This small change will greatly improve the user experience.

Additional Information:

  • Clear and distinct CLI commands will reduce user errors and improve user satisfaction.
  • This change aligns with best practices for creating user-friendly CLI interfaces.

Environment:

  • Operating System:
  • Application Version:

Please feel free to add any additional information or suggestions related to this issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions