Specifications for cmdse: the search engine of bash commands¶
Feature-rich, semantic-wise crowdourced knowledge hub and search engine for useful command-line snippets.
Note
See github.com/cmdse/core library for an implementation of thoses specifications.
Warning
This document is a working draft and subject to heavy change in a near future.
Introduction¶
The motivations behind the creation of cmdse originates from a very simple reasoning.
- How many times I have relied on Google to look for the syntax of a specific command; what if I could search by command directly from the shell ?
- How often I had a precise idea of what I wanted to do, but no idea which shell snippet would drive me there ?
- What if I could finally learn those commands and their semantics, instead of running off memorising those ?
The cmdse program should meet the following requirements:
- Provide a user-friendly cmdse command line tool to query linux-shell command snippets.
- Enable the user to query what he wants to do, and the search engine grabs the best-matched snippets.
- Enable features to memorize the semantics of commonly used commands with mini-quizz.
- Model rich meta-data on program arguments and options, allowing the user to learn the semantics of the programs and snippets he uses.
- Support
bash
andPOSIX Shell
syntaxes. - Infer if a snippet is
POSIX Shell
orbash
-compatible.