xcube-dev / xcube-dev/xcengine

Redesign CLI

Open
#75 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4
Forks
0
Avg merge
2d 19h
Merged PRs (30d)
8

Description

xcengine's functionality has grown significantly since the initial version and the CLI command structure is starting to look like a poor fit. It probably needs a redesign -- not yet, but when the functionality has stabilized a bit more.

Current considerations:

  • xcetool should perhaps be renamed to xcengine.
  • Top-level subcommands build and run would make more sense than the current image and make-script.
    • Promote build and run from image subcommands to top-level subcommands.
    • Distribute current make-script functionality among the new build and run subcommands.

These considerations may change as functionality evolves.

See also #43 .

Contributor guide

No contributing guide indexed for this repository

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 documenting the current xcetool command structure, especially the image and make-script entry points and their build and run subcommands. Review the related discussion in #43 before proposing a stable command design; this issue is complete only when the redesign scope and resulting command structure are agreed.

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.