loading...
Cover image for Sharing command line expertise: Mouse over attribute to get explanation.
kmdr

Sharing command line expertise: Mouse over attribute to get explanation.

_ianeta profile image Ianeta Hutchinson ・2 min read

In kmdr v0.4, we are introducing Explain Session web pages and enabling kmdr users to share command explanations from the cli. Bringing kmdr to the browser is a milestone on our path to a browser extension that will provide attribute level explanations of any commands you select.

An Explain Session web page features the command as a code snippet with each of its attributes explained through pop-ups triggered by mouse-over. Viewers can also sign-up for exclusive access to the incoming browser extension through the web page.

The install instructions featured also have mouse over explanations and showcase the use case for embedding kmdr explanations into documentation.

Embedded explanation

See explanation session web page from the git example above.

Explanation session web pages can be created by any kmdr v0.4 user. The option to share explanations via URL is provided after every command query.

Alt Text

Upon choosing the share option, you will be prompted to input a summary of the command. The summary is rendered as the title of the Explain Session web page when opened in a browser.

Alt Text

The next milestone en-route to a browser extension is user account creation. This feature will ensure synchronization between CLI and browser as you discover new commands, want explanations, and then execute. To gain exclusive access to new features, sign up to our newsletter!

Discussion

pic
Editor guide