syntasso / kratix-cli

CLI-based tool to build Promises
Apache License 2.0
2 stars 2 forks source link

kratix promise scaffolding CLI design 💎 🙌 #1

Closed ChunyiLyu closed 5 months ago

ChunyiLyu commented 5 months ago

Context

Shaping board: https://miro.com/app/board/uXjVKE2sj28=/ Come up with guiding principles for our kratix promise scaffolding CLI so our UI can stay consistent and not surprising to users.

We can look into other popular CLI tools, such as kubectl, kubebuilder, flux, rails, etc

We plan to add more functionality to this cli in the future, keep the design flexible and extensible so we can do things like getting logs, testing and kratix management commands easily.

Output of this issue

  1. Design principles that specify CLI syntax and overall format of all available commands. kubectl, for example, has a very clear syntax that we can use for inspiration. Think about:
    • command format
    • global arguments
    • positional vs flags
    • environment variables
  2. List of commands that follow our design principles that we will implement as part of this track of work. Please update their corresponding issues.
ChunyiLyu commented 5 months ago

Design: https://github.com/syntasso/kratix-cli/blob/main/docs/design.md