OpenEnergyPlatform / OpenEnergyPlatform/omi

Enhance CLI feedback

Open
#153 0 comments 0 reactions 1 assignee View on GitHub

@jh-RLI is already working on this.

Since Sep 15, 2026.

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

Description

Description of the issue

The OMI CLI currently provides only limited feedback after running commands.

During testing, it was often unclear which files were created and what the next step should be. Users therefore need to manually inspect the generated folders.

More CLI feedback could make the workflow easier to follow, especially for new users.

Examples

After omi dataset:

  • show a success message, e.g. Dataset successfully created
  • show which dataset files were created
  • optionally suggest omi resources as the next step

After omi resources:

  • show a success message
  • show how many CSV files were processed
  • show which resource YAML files were created

After omi assemble:

  • show a success message, e.g. OEMetadata JSON successfully created
  • show where the JSON file was created
  • optionally warn about missing metadata such as title, description or license

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.