Skip to content

Latest commit

 

History

History
109 lines (71 loc) · 2.57 KB

README.md

File metadata and controls

109 lines (71 loc) · 2.57 KB
Raw

go-keybase-chat-bot

Script Keybase Chat in Go!

This is my fork of keybase/go-keybase-chatbot.

This module is a side-project/work in progress and may change or have crashes, but feel free to play with it. As long as you're logged in as a Keybase user, you can use this module to script basic chat commands.

Installation

Make sure to install Keybase.

go get -u github.com/keybase/go-keybase-chat-bot/...

Hello world

package main

import (
	"flag"
	"fmt"
	"os"

	"github.com/keybase/go-keybase-chat-bot/kbchat"
)

func fail(msg string, args ...interface{}) {
	fmt.Fprintf(os.Stderr, msg+"\n", args...)
	os.Exit(3)
}

func main() {
	var kbLoc string
	var kbc *kbchat.API
	var err error

	flag.StringVar(&kbLoc, "keybase", "keybase", "the location of the Keybase app")
	flag.Parse()

	if kbc, err = kbchat.Start(kbLoc); err != nil {
		fail("Error creating API: %s", err.Error())
	}

	tlfName := fmt.Sprintf("%s,%s", kbc.Username(), "kb_monbot")
	fmt.Printf("saying hello on conversation: %s\n", tlfName)
	if err = kbc.SendMessageByTlfName(tlfName, "hello!"); err != nil {
		fail("Error sending message; %s", err.Error())
	}
}

Commands

Start(keybaseLocation string) *API

This must be run first in order to start the Keybase JSON API stdin/stdout interactive mode.

API.SendMessageByTlfName(tlfName string, body string) error

send a new message by specifying a TLF name

API.SendMessage(convID string, body string) error

send a new message by specifying a conversation ID

API.GetConversations(unreadOnly bool) ([]Conversation, error)

get all conversations, optionally filtering for unread status

API.GetTextMessages(convID string, unreadOnly bool) ([]Message, error)

get all text messages, optionally filtering for unread status

Reads the messages in a channel. You can read with or without marking as read.

API.ListenForNextTextMessages() NewMessageSubscription

Returns an object that allows for a bot to enter into a loop calling NewMessageSubscription.Read to receive any new message across all conversations (except the bots own messages). See the following example:

	sub := kbc.ListenForNewTextMessages()
	for {
		msg, err := sub.Read()
		if err != nil {
			fail("failed to read message: %s", err.Error())
		}

		if err = kbc.SendMessage(msg.Conversation.Id, msg.Message.Content.Text.Body); err != nil {
			fail("error echo'ing message: %s", err.Error())
		}
	}

TODO:

  • attachment handling (posting/getting)
  • edit/delete
  • many other things!

Contributions

  • welcomed!