Learn How to Shell with Explain Shell

Learn How to Shell with Explain Shell

ExplainShell.com is an online tool built by Idan Kamara that visually explains each part of a Unix command by matching command-line arguments to their help text.

You can paste some code, and the site will break down each piece of the command. For example, take the following find command:

find . -type f -print0

The command will produce the following explanation that allows you to filter and navigate each part of the command:

Here’s the background of the material and technologies used to create explainshell.com:

This site contains 29761 parsed manpages from sections 1 and 8 found in Ubuntu’s manpage repository. A lot of heuristics were used to extract the arguments of each program, and there are errors here and there, especially in manpages that have a non-standard layout.

It is written in Python and uses bashlex, a bit of NLTK (to find the interesting parts of the manpage), a little d3.js (for the connecting lines graphic) and Flask. It is served with uwsgi and nginx. Source code is available on github.

You can try it out at explainshell.com. The source code is also available on GitHub.

Another manpage tool we’ve covered is the excellent TLDR Pages and accompanying command line tool.


Filed in: News / Terminal


Newsletter

Join the weekly newsletter and never miss out on new tips, tutorials, and more.

Laravel News Partners

Laravel Jobs

Software Engineer Lead (PHP)
Remote
CivicPlus, LLC
Full-time Senior Web Developer
Detroit, MI
Wayne State University
Senior Software Engineer
Sydney, Australia
FoodByUs
Full Stack Engineer
Remote or Medford, Oregon
Empire Medical
Laravel Developer (fulltime - Dutch only)
Netherlands
Qbixx | Webservices
Full Stack or Back-End Developer
Alexandria, VA; Tallahassee, FL; Orlando, FL
Marketing for Change
Senior Quality Assurance Engineer
Remote
Bisnow Media