Exempli Gratia

Mo, 19. April 2021, Ralf Hersel

Die Anzahl von Kommandozeilenbefehlen im Linux-Terminal ist gigantisch. Durch die tägliche Arbeit kennt man viele dieser Befehle, aber noch lange nicht alle. Wer sich nur gelegentlich auf der Kommandozeile bewegt, hat es schwerer. Wie funktioniert dieser 'grep' Befehl nochmal? Unterstützung hierfür bietet das Python-Skript 'eg', was so viel bedeutet wie 'example given', also 'zum Beispiel', oder eben 'exempli gratia' für die Lateiner unter den Lesern.

Nun mag man einwenden, dass es doch die Man-Pages gibt. Nach der Eingabe von 'man grep' erhält man eine seitenlange Erklärung, wie der Befehl grep funktioniert. Wenn man lange genug scrollt, findet sich sogar ein Beispiel zur Verwendung des Befehls. 'Eg' geht einen anderen Weg. Es zeigt ausschliesslich Beispiele mit einer kurzen Beschreibung dazu, was das Beispiel macht. Die Installation des Werkzeugs geschieht mittels PIP:

pip install eg

Danach kann gestartet werden, indem man 'eg' gefolgt von einem beliebigen Befehl aufrufen, zum Beispiel 'eg grep', wie in der Bildschirmaufnahme zu sehen ist. Eg unterstützt 80 Befehle. Welche das sind, kann man mit 'eg --list' anzeigen lassen. Die Menge der unterstützten Befehle und die Beispiele dazu, lassen sich beliebig erweitern. Um es kurz zu machen, 'eg' schaut zu jedem Befehl nach einer Markdown-Datei (z.B. 'grep.md') und piped den Inhalt durch 'less', um eine paginierte Ausgabe zu erhalten. Eine genaue Anleitung, wie sich die Beispielsammlung ändern und erweitern lässt, findet sich auf der GitHub-Seite von 'eg'. Dort werden auch die vielen Konfigurationsmöglichkeiten des Werkzeugs beschrieben. Natürlich kann man auch 'eg' befragen, wie es funktioniert. Mit 'eg eg' liefert es die Beispiele zu sich selbst.

Quelle: https://github.com/srsudar/eg

Rayman
Geschrieben von Rayman am 19. April 2021

In eine ähnliche Richtung geht auch https://www.tutonaut.de/neues-projekt-cli-help-praktische-hilfe-im-terminal-auf-deutsch/

Wobei hier natürlich eine funktionierende Internetverbindung vorausgesetzt werden muss.

Tom
Geschrieben von Tom am 19. April 2021

An dieser Stelle sei noch das Tool "tldr" erwähnt, welches eine ähnliche Aufgabe erledigt: https://github.com/tldr-pages/tldr

Auf der Gtihub Seite sind unten auch unterschiedliche Clients von tldr in unterschiedlichen Sprachen aufgeführt. Ebenso gibt's ganz unten einen Vergleich zu anderen Tools - auch dem hier genannten eg.

Danke für den Hinweis - eg kannte ich noch nicht.

y1n
Geschrieben von y1n am 19. April 2021

sehr interessantes tool, es scheint aber, es ist im namenskonflikt mit 'easygit'