A small reference, built carefully
Shell Explain pairs original Markdown explanations with an offline Go CLI and this static Astro website. The same validated content supplies both interfaces.
Status
This website is live. The CLI is still a local development build: no public binary, installer, or package-manager release is available yet. The source repository is public, and releasing the CLI is planned for stage 5.
Source code:github.com/ninegene/shell-explain
Content revision: 66bb98be0aa6fd1c06016a53e1c0a84796911ddc9735cb3aa94753081ae69792
Choose the right tool
macOS can have GNU tools installed, and Linux can use BusyBox. Choose an implementation explicitly on the website. The CLI can inspect executable paths and use bounded version probes; it cannot see aliases or functions inside your parent shell. Examples are not automatically executed.
Sources and inspiration
Every command page links upstream references. The prose and examples here are original. This project takes inspiration from tldr-pages, ExplainShell, and eg; it does not import their text.
Licensing
Original explanations and guides are licensed under CC BY 4.0. Credit Shell Explain contributors, link to the source and license, and indicate changes when sharing. Software and shell examples use the MIT License. Third-party materials retain their own licenses.
Contributing later
Once the project opens to the public, contributors will be able to propose commands, examples, and portability corrections through reviewed Markdown pull requests. The contribution process will be verified before that launch.