Skip to content

Add CLI default help message #47

@ariel-m-s

Description

@ariel-m-s

I think that showing a help message when using the CLI in a wrong way would be helpful. For instance, when typing zum (without any arguments), the CLI currently outputs an exception (as shown bellow). I find this to be a little aggresive for newcomers (like me) who are beginning to experiment with Zum.

Traceback (most recent call last):
  File "/usr/local/bin/zum", line 8, in <module>
    sys.exit(dispatcher())
  File "/usr/local/lib/python3.9/site-packages/zum/cli.py", line 22, in dispatcher
    engine.execute(parsed_args.action[0], parsed_args.params)  # pragma: nocover
AttributeError: 'Namespace' object has no attribute 'action'

This help message should’t be as complete as the documentation, but should provide some practical information such as a list of commands and possible arguments.

Metadata

Metadata

Assignees

No one assigned

    Labels

    proposalFor new ideas not being considered at that moment

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions