8min
|
Writers
|
Updated 18 Nov 2020
Print

Get started with kmdr-cli

This document describes how to install and sign-in to the kmdr-cli.

Prerequisites

You will need to have the following installed on your computer:

  • A package manager like npm
  • Node.js v8.x and above

Install

Use your package manager (ie npm) to install kmdr-cli.



Check installation

Check if kmdr was correctly installed on your system.



Log in

kmdr uses an email-based, passwordless authentication for logging in. Whether the it is your first time using kmdr or you are a returning user, you will be prompted to authenticate via email in order to run queries.

Log in to the kmdr-cli and enter your email where prompted

Check your email inbox and click on the link provided in the email from kmdr. You will have 10 minutes to authenticate before the link expires and you are required to re-enter your email to receive a new link.

You will now be able to run queries using the kmdr-cli. We highly recommend that you Create an account. Accounts enable you to browse your command history, save commands to your cheatsheet and share commands with their definitions via embed or url.