Yetibot

AI-Quellcode

1.0.0

Herunterladen

Ein in Clojure geschriebener Chatbot zu Ihren Diensten.

Yetibot

Sie können sich Yetibot als eine gemeinschaftliche Befehlszeile vorstellen. Es zeichnet sich aus durch:

Unterrichten : Ausführen interner Automatisierung, Sprachbewertung für JS, Scala, Clojure und Haskell
Produktivität : Dinge rund um Jenkins und JIRA automatisieren, SSH-Befehle auf verschiedenen Servern ausführen und über private Yetibot-Plugins mit internen APIs interagieren
Spaß : Google-Bildersuche, GIF-Suche, Meme-Generierung

Funktionen, die Yetibot leistungsstark und großartig machen, das heißt: Spaß machen:

Pipes im Unix-Stil ermöglichen eine enorme Ausdruckskraft bei der Verkettung komplexer und flexibler Befehle.
Mit Unterausdrücken können Sie die Ausgabe eines Befehls in einen äußeren Befehl einbetten. Sie können so viele Ebenen tief verschachtelt sein, wie Sie sich vorstellen können (öffnen Sie eine PR, um sie zu BEISPIELEN hinzuzufügen, wenn Ihnen etwas Verrücktes einfällt!).
Mit Aliasen können Sie komplexe Ausdrücke parametrisieren und ihnen einen Namen geben, sodass Ihr Team schnell teamspezifische Yetibot-Redewendungen (nicht nur Memes!) erstellen kann.
Mit den Einstellungen pro Kanal können Sie beliebige Konfigurationen auf Kanalebene speichern, die von Befehlen oder Aliasen verwendet werden können, um das Verhalten von Befehlen abhängig davon zu ändern, in welchem Kanal Sie sich befinden (z. B. die Standard-JIRA-Projekte für einen Kanal).
Durch das Umschalten der Funktionskategorie können Sie ganze Befehlskategorien pro Kanal deaktivieren oder aktivieren. Nützlich zum Deaktivieren von GIFs im Nur-Arbeits-Kanal?

Werfen Sie einen Blick auf die Anwendungsbeispiele, um einige zu sehen ~~Spaß~~ nützliche Dinge, die es tun kann.

Dieses Projekt wird unterstützt von:

Neue Mitwirkende

Willkommen neue Mitwirkende!

Fühlen Sie sich frei, jedes Problem anzugehen
Ausgaben mit der Bezeichnung good first issue sind gut für Erstautoren von Yetibot
Bitten Sie @devth um Hilfe auf Slack, GitHub oder wo auch immer Sie ihn finden können

Benutzen Sie es jetzt

Erhalten Sie eine Einladung zum offiziellen Yetibot-Slack unter slack.yetibot.com. Yetibot läuft auf einem von DigitalOcean großzügig bereitgestellten Droplet, mit dem Sie in Slack spielen können.

Erste Schritte

Um Yetibot schnell mit minimaler Konfiguration auszuprobieren:

Sehen Sie sich die Dokumentation „Erste Schritte“ an, einschließlich eines Docker Compose-Beispiels
Yetibot auf Docker-Dokumenten, wenn Sie es mit Docker ausführen möchten

Yetibot-Benutzer

Nutzen Sie Yetibot bereits? Bitte tragen Sie sich in die Liste der Yetibot-Benutzer ein!

Mitwirken

Siehe BEITRAGEN.

Straßenkarte

Yetibot wurde seit seiner Einführung kontinuierlich verbessert. Dies sind die unmittelbaren Prioritäten, zusätzlich zu etwaigen Fehlerbehebungen. Feedback und Beiträge sind herzlich willkommen!

Schreiben Sie Dokumente zur Entwicklung von Yetibot – siehe Dev Guide
Dockerisieren Sie Yetibot. Erledigt! Schauen Sie sich die Anweisungen an.
Integrieren Sie StackStorm für die Automatisierung von Steroiden. Erledigt! Schauen Sie sich Yetibot-Stackstorm an.
Erstellen Sie eine Heroku-Bereitstellungsschaltfläche, um den Einstieg zu erleichtern
Machen Sie Adapter steckbar
Weitere Beispiele für Plugins erstellen (z. B. Travis)
Führen Sie eine Demo-Yetibot-Instanz aus – Sie können jetzt mit einem Yetibot auf Freenode im #yetibot -Kanal sprechen oder Yetibot Slack beitreten!
Entwerfen und erstellen Sie Yetibot.com – Fertig!
Reduzieren Sie die Konfiguration und laden Sie sie über die Umgebung herunter, um die 12-Faktor-App-Praktiken Nr. 570 zu befolgen

Installation

Es gibt mehrere Möglichkeiten, Yetibot auszuführen:

Befolgen Sie die Docker-Anweisungen : Der schnellste Weg, wenn Sie Docker bereits verwenden.
Yetibot-Helm : die offizielle Helm-Tabelle zum schnellen Ausführen von Yetibot auf Kubernetes.
Klonen Sie dieses Repo : Dadurch erhalten Sie eine Standard-Yetibot-Installation und einen Git-ignorierten Ort zum Speichern der Konfiguration. Führen Sie lein run aus dem Root-Verzeichnis aus.
Erstellen Sie Ihr eigenes Repo und verlassen Sie sich auf Yetibot : Dies bietet Ihnen ultimative Anpassbarkeit, ermöglicht es Ihnen, sich auf benutzerdefinierte Yetibot-Plugins zu verlassen oder Ihre eigenen Befehle im Projekt zu definieren, und gibt Ihnen die Kontrolle darüber, wo Sie Ihre Konfiguration speichern (manuelle Verwaltung, Festschreibung an privates Git). Repo usw.)

Konfiguration

Siehe Konfigurationsdokumente.

Verwendung

Weitere Dokumente finden Sie im Benutzerhandbuch.

Allen Befehlen wird ein ! vorangestellt. .

Rohre

Die Ausgabe eines Befehls kann wie bei Unix-Pipes an einen anderen weitergeleitet werden.

 !complete does IE support | xargs echo %s? No, it is sucky.

does ie support html5? No, it is sucky.
does ie support css3? No, it is sucky.
does ie support svg? No, it is sucky.
does ie support media queries? No, it is sucky.
does ie support ftps? No, it is sucky.
does ie support png? No, it is sucky.
does ie support canvas? No, it is sucky.
does ie support @font-face? No, it is sucky.
does ie support webgl? No, it is sucky.
does ie support ttf? No, it is sucky.

Backticks

Backticks bieten eine einfache Syntax für Unterausdrücke, können jedoch nicht verschachtelt werden.

 !meme grumpy cat: `catfact` / False

Verschachtelte Unterausdrücke

Für beliebig verschachtelte Unterausdrücke verwenden Sie die Syntax $(expr) , die das Öffnen und Schließen eines Ausdrucks eindeutig macht.

 !meme philos: $(complete how does one $(users | random | letters | random) | random)

Combo

 !echo `repeat 4 echo i don't always repeat myself but | unwords`…StackOverflowError | meme interesting:

Aliase

Sie können zur Laufzeit Ihre eigenen Aliase erstellen. Diese werden in der konfigurierten Datenbank gespeichert und beim Neustart wiederhergestellt.

 !alias nogrid = repeat 3 echo `repeat 3 meme grumpy: no | join`

Pipes können verwendet werden, aber die rechte Seite muss in Anführungszeichen gesetzt werden, um sie als Literal zu behandeln, anstatt gemäß dem normalen Pipe-Verhalten ausgewertet zu werden.

 !alias i5 = "random | echo http://icons.wunderground.com/webcamramdisk/w/a/wadot/324/current.jpg?t=%s&.jpg"

Sie können Platzhalterargumente auf der rechten Seite angeben, indem Sie $s verwenden, um alle Argumente anzugeben, oder $n (wobei n ein 1-basierter Index von which arg ist).

33.6 F (0.9 C), Overcast">

 !alias temp = "weather $s | head 2 | tail"
!temp 98104
=> 33.6 F (0.9 C), Overcast

Adapterkonfiguration

IRC : Yetibot kann auf beliebig vielen Kanälen hören. Sie konfigurieren Kanäle in config.edn. Sie können Yetibot auch zur Laufzeit mit dem IRC-Befehl /invite zu einem Kanal einladen:

 /invite yetibot #whoa

Wenn Sie Yetibot zu einem neuen Kanal einladen, wird config.edn überschrieben, sodass Yetibot beim nächsten Neustart wieder denselben Kanälen beitritt.

Sie können Yetibot auch mit dem Befehl !room anweisen, einem Kanal beizutreten oder ihn zu verlassen.

 !help room
room join  # join 
room leave  # leave 
room list # list rooms that yetibot is in
room set   # configure a setting for the current room
room settings # show all chat settings for this room
room settings  # show the value for a single setting

Slack : Bots können einem Kanal nicht alleine beitreten, sie müssen eingeladen werden, daher gilt die Raumkonfiguration nicht. Stattdessen /invite @yetibot zu jedem Kanal, in dem Sie sich befinden, und /kick @yetibot wenn Sie möchten, dass er den Kanal verlässt. Hinweis: Zum Kicken benötigen Sie möglicherweise besondere Privilegien.

Lagerfeuer wird nicht mehr unterstützt. Wenn Sie Campfire verwenden, öffnen Sie ein Problem und wir können es wieder hinzufügen!

Andere Chat-Plattformen : Wenn die Chat-Plattform Ihrer Wahl nicht unterstützt wird, öffnen Sie ein Problem. Das Hinzufügen von Adaptern ist ganz einfach.

Übertragen

Wenn für einen Raum broadcast auf true eingestellt ist, werden Tweets in diesem Raum gepostet. Standardmäßig ist es in allen Räumen auf „false“ eingestellt. So aktivieren Sie:

 !room set broadcast true

Helfen

Yetibot dokumentiert sich selbst mithilfe der Dokumentzeichenfolgen seiner verschiedenen Befehle. Fragen Sie nach !help um eine Liste der Hilfethemen zu erhalten. !help all zeigt die vollständig erweiterte Befehlsliste für jedes Thema an.

 !help | join ,

 Use help  for more details, !, that, alias, ascii, asciichart,
attack, buffer, catfact, chat, chuck, classnamer, clj, cls, complete, config,
count, curl, ebay, echo, eval, features, gh, giftv, grep, haiku, head, help,
history, horse, hs, http, image, info, jargon, jen, join, js, keys, list, log,
mail, meme, memethat, mustachefact, number, order, poke, poms, random, raw,
react, reload, repeat, rest, reverse, rhyme, scala, scalex, sed, set, sort, source,
split, ssh, status, tail, take, tee, twitter, update, uptime, urban, users,
vals, weather, wiki, wolfram, wordnik, words, xargs, xkcd, zen

Plugins

Yetibot verfügt über eine Plugin-basierte Architektur. Sein Kern, von dem alle Plugins abhängen, ist Yetibot.core.

Yetibot lädt alle Befehle und Beobachter mit Namespaces im Klassenpfad, die diesen regulären Ausdrücken entsprechen.

Dadurch können Sie beliebig viele unabhängige Plugin-Projekte erstellen und diese über Standard-Leiningen-Abhängigkeiten kombinieren.

Wie es funktioniert

Neugierig, wie die Interna von Yetibot funktionieren? Auf hohem Niveau:

Befehle werden durch einen Parser ausgeführt, der auf InstaParse basiert:
Ein InstaParse-Transformer ist so konfiguriert, dass er Ausdrücke über den Interpreter auswertet, der Dinge wie verschachtelte Unterausdrücke und Pipeline-Befehle verarbeitet
Befehlsnamespaces werden mithilfe eines cmd-hook Makros in die handle-cmd Funktion des Interpreters hook und über den Regex-Präfixabgleich ausgelöst

Hilfe bekommen

Wenn Ihnen die Dokumente oder der Implementierungscode nicht weiterhelfen, öffnen Sie bitte eine Pull-Anfrage und erläutern Sie den Grund, damit wir die Dokumente verbessern können. Sie können auch gerne eine Ausgabe für Funktionsanfragen eröffnen!