elman

Elman?

Ein Skript für Volltext, die Linux -Man -Seiten mit Elasticsearch sucht.

Es wurde entwickelt, um mit der in diesem Beitrag beschriebenen Idee herumzuspielen .

Wie funktioniert es

Angesichts der Tatsache, dass Sie über eine laufende Elasticsearch -Instanz verfügen, erstellt das Skript einen Index namens elman und füttert sie mit den Menschenseiten Ihres Linux -Systems mithilfe der apropos . Befehl, um alle verfügbaren Seiten zu erhalten. Anschließend können Sie es zur Volltext -Suche auf den Mannseiten so einfach wie folgt verwenden:

elman concatenate files

Installation

Es ist ein Ruby -Skript, sodass Sie die Sprache installieren müssen.

Klonen Sie dieses Repository und aus der Ausführung des Verzeichnisses des Skripts:

bundle

So installieren Sie das elasticsearch -Gem und seine Abhängigkeiten.

Notiz

Wenn Sie keinen Bundler in Ihrem System haben, installieren Sie es mit:

gem install bundler

Richten Sie den Elasticsearch -Index ein

So richten Sie den Index ein und laden Sie die Verwendungsseiten:

./elman -s

oder

./elman --setup

Ausfall ändern

Das Skript erstellt eine Datei unter Ihrem Heimverzeichnis namens .elman.yml . Ändern Sie den Inhalt, um Ihrem Setup zu entsprechen:

---
:elasticsearch :
  :host : localhost
  :port : ' 9200 '
  :search_results_size : 10 

Verwendung

Volltext -Suche

Um die Mannseiten zu durchsuchen, verwenden Sie:

elman < query > 

Beispiel:

elman edit images

Todo

• Suchdefinition verbessern

Beitragen

1. Fork It (https://github.com/iridakos/elman/fork)
2. Erstellen Sie Ihre Funktionszweig ( git checkout -b my-new-feature ).
3. Bestimmen Sie Ihre Änderungen ( git commit -am 'Add some feature' )
4. Drücken Sie in den Zweig ( git push origin my-new-feature )
5. Erstellen Sie eine neue Pull -Anfrage

Lizenz

Dieses Tool ist Open Source unter den MIT -Lizenzbedingungen.