OpenCyphal / OpenCyphal/yakut

CLI is dumb

Open
#103 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
65
Forks
14
PR merge metrics
No merged PRs in 30d

Description

The Yakut CLI is overly rigid and unintelligent. Example:

> yakut mon -h
Usage: yakut monitor [OPTIONS]
Try 'yakut monitor --help' for help.

Error: No such option: -h

> yakut mon --path ~/.dsdl/types

Usage: yakut monitor [OPTIONS]
Try 'yakut monitor --help' for help.

Error: No such option: --path

> yakut mon --help --path ~/.dsdl/types

Usage: yakut monitor [OPTIONS]
Try 'yakut monitor --help' for help.

Error: No such option: --path

> yakut mon --help

(no --path option shown)

> yakut mon

Error: Run `yakut compile <path>/uavcan` to compile DSDL namespace 'uavcan'

Modern CLIs are flexible and smart. click is obviously retrograde and should be disused.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the CLI entry points behind yakut mon and yakut monitor, including how the shown options and errors are handled through Click. Compare the requested behavior with the examples in the issue and clarify the intended scope before changing anything; done requires an agreed design for more flexible command and option handling.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.