{"id":13602799,"url":"https://github.com/ExplainDev/kmdr-cli","last_synced_at":"2025-04-11T13:31:24.894Z","repository":{"id":43505236,"uuid":"102768432","full_name":"ExplainDev/kmdr-cli","owner":"ExplainDev","description":"🧠 The CLI tool for learning commands from your terminal","archived":true,"fork":false,"pushed_at":"2022-02-27T08:42:25.000Z","size":11950,"stargazers_count":250,"open_issues_count":12,"forks_count":28,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-10-30T02:37:02.416Z","etag":null,"topics":["bash","bash-shell","cli","command-line","shell","terminal"],"latest_commit_sha":null,"homepage":"https://kmdr.sh/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ExplainDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-07T17:51:46.000Z","updated_at":"2024-07-22T16:59:39.000Z","dependencies_parsed_at":"2022-08-23T10:21:47.251Z","dependency_job_id":null,"html_url":"https://github.com/ExplainDev/kmdr-cli","commit_stats":null,"previous_names":["kommandr/kmdr.sh","kommandr/kmdr-cli"],"tags_count":100,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExplainDev%2Fkmdr-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExplainDev%2Fkmdr-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExplainDev%2Fkmdr-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExplainDev%2Fkmdr-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ExplainDev","download_url":"https://codeload.github.com/ExplainDev/kmdr-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223470262,"owners_count":17150523,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","bash-shell","cli","command-line","shell","terminal"],"created_at":"2024-08-01T18:01:38.387Z","updated_at":"2024-11-07T06:30:20.613Z","avatar_url":"https://github.com/ExplainDev.png","language":"TypeScript","readme":"# kmdr-cli ![npm](https://img.shields.io/npm/v/kmdr?color=green\u0026style=flat-square)![npm](https://img.shields.io/npm/dt/kmdr?color=blue\u0026style=flat-square)\n\n\u003e The CLI tool for learning commands from your terminal\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"screenshot.png\"\u003e\n\u003c/p\u003e\n\n`kmdr` provides command explanations for hundreds of programs including `git`, `docker`, `kubectl`,`npm`, `go` and more straight forward programs such as those built into `bash`. See the full list at https://app.kmdr.sh/program.\n\n## Installation\n\nYou will need to install the kmdr program and sign-in to begin using kmdr on the CLI.\n\n### Requirements\n\n- Node.js v8.x and above\n- A package manager like `npm` or `yarn`\n\n#### With `npm`\n\n```bash\nnpm install kmdr --global\n```\n\n#### With `yarn`\n\n```bash\nyarn global add kmdr\n```\n\n### Check installation\n\nRun the command `kmdr` to check if it was correctly installed on your system.\n\n```bash\n$ kmdr\nUsage: kmdr [options] [command]\n\nThe CLI tool for learning commands from your terminal\n\nLearn more at https://kmdr.sh/\n\nOptions:\n  -v, --version    output the version number\n  -h, --help       output usage information\n\nCommands:\n  explain|e        Explain a shell command\n  info|i           Display system-wide information\n  login|l [email]  Log in to kmdr\n  logout           Log out from kmdr\n  settings|s       Adjust options and preferences\n  version|v        Print current version and check for newer release\n```\n\n#### Troubleshooting installation\n\n##### Command not found: kmdr\n\nAdd the line below to your `.bashrc` or `.zshrc` if using `zsh`\n\n```bash\nexport PATH=\"$(yarn global bin):$PATH\"\n```\n\n### Sign In\n\n1. Log in on the kmdr CLI tool\n\n```bash\nkmdr login\n```\n\n2. Enter your email when prompted\n3. Check your inbox and click on the link provided in the email.\n\n## Usage\n\n### Explain a command\n\nOnce `kmdr-cli` is installed on your system, enter `kmdr explain` to return a prompt for entering the command you would like explained.\n\nWhen the `Enter your command:` prompt is returned, enter the command you would like explained and hit the `Enter` key.\n\n`kmdr` will return syntax highlighting to assist you in differentiating parts of the command followed by the explanation of each of these parts.\n\nAn example explanation of `git commit -am \"Initial commit\"` can be seen below.\n\n```bash\n$ kmdr explain\n✔ Enter your command · git commit -am \"Initial Commit\"\n\n    git commit -am \"Initial Commit\"\n\n  DEFINITIONS\n\n    git\n      The stupid content tracker\n    commit\n      Record changes to the repository\n    -a, --all\n      Tell the command to automatically stage files that have been modified and deleted\n    -m, --message \"Initial Commit\"\n      Use the given \u003cmsg\u003e as the commit message\n```\n\n### Examples\n\n#### Explaining commands with subcommands\n\n```bash\n$ kmdr explain\n? Enter your command: npm install kmdr@latest --global\n\n    npm install kmdr@latest --global\n\n  DEFINITIONS\n\n    npm\n      Package manager for the Node JavaScript platform\n    install\n      Install a package\n    kmdr@latest\n      The CLI tool for learning commands from your terminal\n    -g, --global\n      Install the package globally rather than locally\n```\n\n#### Explanining commands with grouped options\n\n```bash\n$ kmdr explain\n? Enter your command: rsync -anv file1 file2\n\n    rsync -anv file1 file2\n\n  DEFINITIONS\n\n    rsync\n      A fast, versatile, remote (and local) file-copying tool\n    -a, --archive\n      This is equivalent to -rlptgoD.\n    -n, --dry-run\n      This makes rsync perform a trial run that doesn’t make any changes\n      (and produces mostly the same output as a real run).\n    -v, --verbose\n      This option increases the amount of information you are given during\n      the transfer.\n```\n\n#### Explaining commands with redireciton\n\n```bash\n$ kmdr explain\n? Enter your command: ls -alh \u003e contents.txt\n\n    ls -alh \u003e contents.txt\n\n  DEFINITIONS\n\n    ls\n      List directory contents\n    -a, --all\n      Do not ignore entries starting with .\n    -l\n      Use a long listing format\n    -h, --human-readable\n      With -l and/or -s, print human readable sizes (e.g., 1K 234M 2G)\n    \u003e contents.txt\n      Redirect stdout to contents.txt.\n```\n\n#### Explaining list of commands\n\n```bash\n$ kmdr explain\n? Enter your command: dmesg | grep 'usb' \u003e output.log 2\u003eerror.log\n\n    dmesg | grep 'usb' \u003e output.log 2\u003e error.log\n\n  DEFINITIONS\n\n    dmesg\n      Print or control the kernel ring buffer\n    |\n      A pipe serves the sdout of the previous command as input (stdin) to the next one\n    grep\n      Print lines matching a pattern\n    \u003e output.log\n      Redirect stdout to output.log.\n    2\u003e error.log\n      Redirect stderr to error.log.\n```\n\nSo what is the reason for signing in? why should it be included in CLI readme?\n\n## Supported programs\n\nWe add new programs every day! See the full list here: https://app.kmdr.sh/program.\n\n## Stay tuned for more updates\n\n- Visit our website \u003chttps://kmdr.sh/\u003e\n- Follow us on twitter \u003chttp://twitter.com/kmdr_sh\u003e\n","funding_links":[],"categories":["TypeScript","cli"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FExplainDev%2Fkmdr-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FExplainDev%2Fkmdr-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FExplainDev%2Fkmdr-cli/lists"}