Documentation ¶
Overview ¶
This is a sample main.go file which includes setup for a stdio connection and plugins that do not require any configurations. If you'd like to build your own plugins or connections, see our DEVELOP.md documentation
Directories ¶
Path | Synopsis |
---|---|
Package bot manages the creation of the chatbot and adding plugins to the chatbot.
|
Package bot manages the creation of the chatbot and adding plugins to the chatbot. |
Package config provides access to application-wide configuration.
|
Package config provides access to application-wide configuration. |
Package connection creates the interface for all services that require a connection to the chatbot.
|
Package connection creates the interface for all services that require a connection to the chatbot. |
slack
Package slack is a Connection to the Slack Real Time Messaging API (https://api.slack.com/rtm).
|
Package slack is a Connection to the Slack Real Time Messaging API (https://api.slack.com/rtm). |
stdio
Package stdio is a Connection to a stdin/stdout Terminal session
|
Package stdio is a Connection to a stdin/stdout Terminal session |
Package github is a wrapper around the go Github client and API
|
Package github is a wrapper around the go Github client and API |
Package log serves as a light wrapper around logrus.
|
Package log serves as a light wrapper around logrus. |
Package message contains the structure for basic messages that are allowed to be sent through the RX and TX channels.
|
Package message contains the structure for basic messages that are allowed to be sent through the RX and TX channels. |
Package plugins contains all plugins that interface with the chatbot.
|
Package plugins contains all plugins that interface with the chatbot. |
cats
Package cats is a plugin that queries some cat API's and returns responses.
|
Package cats is a plugin that queries some cat API's and returns responses. |
dice
Package dice is a plugin that will roll dice based on the number of dice you specify and the number of sides on each dice (ex: roll 7 6-sized dice)
|
Package dice is a plugin that will roll dice based on the number of dice you specify and the number of sides on each dice (ex: roll 7 6-sized dice) |
principles
Package principles searches the Handwriting.io team's Engineering principles document and returns the best fit to the search query
|
Package principles searches the Handwriting.io team's Engineering principles document and returns the best fit to the search query |
sample
Package sample is a sample implementation of a plugin.
|
Package sample is a sample implementation of a plugin. |
tableflip
Package tableflip returns an ASCII-based emoticon depicting a person flipping a table out of rage or unflipping the table once thing have cooled down
|
Package tableflip returns an ASCII-based emoticon depicting a person flipping a table out of rage or unflipping the table once thing have cooled down |
write
Package write renders a PNG using the Handwriting.io API.
|
Package write renders a PNG using the Handwriting.io API. |
Click to show internal directories.
Click to hide internal directories.