[INS-2160] [Improvement] Render --help as markdown

instill-ai / instill-core

🔮 Instill Core is a full-stack AI infrastructure tool for data, model and pipeline orchestration, designed to streamline every aspect of building versatile AI-first applications

https://www.instill.tech

Other

2.06k stars 90 forks source link

[INS-2160] [Improvement] Render --help as markdown #631

Open TobiaszCudnik opened 11 months ago

TobiaszCudnik commented 11 months ago

Is There an Existing Issue for This?

[X] I have searched the existing issues

Project

Instill CLI

Is your Proposal Related to a Problem?

Describe Your Proposed Improvement

Using the glow module, we can show a well formatted help messages.

Highlight the Benefits

Readability and nice UI.

Anything Else?

No response

_INS-2160

github-actions[bot] commented 11 months ago

This issue is a great way to kick-start your journey with our project, or to make a positive impact on open-source development. Jump in!

Check out our Contributing Guidelines for a smooth experience
Remember to link your pull request to this issue

:sparkles: Thank you for your contribution! :sparkles:

syedzubeen commented 11 months ago

Can I take this one?

pinglin commented 11 months ago

@syedzubeen Absolutely. Thanks for being interested in contributing.

syedzubeen commented 11 months ago

@harshsoni7 Glow seems like a plug-and-play kind of thing. You install it and render markdowns on your terminal. It doesn't seem to provide any functions to integrate it with an existing go CLI. There isn't any documentation as such on https://pkg.go.dev/github.com/charmbracelet/glow#section-documentation

Correct me if I am wrong here. However, I see another package by the same vendor named lipgloss that does CLI output styling. https://pkg.go.dev/github.com/charmbracelet/lipgloss