https://github.com/yetibot/core

:expressionless: Core yetibot utilities, extracted for shared use among Yetibot and its various plugins
https://github.com/yetibot/core

chatbot clojure yetibot yetibot-plugins

Last synced: 3 months ago
JSON representation

:expressionless: Core yetibot utilities, extracted for shared use among Yetibot and its various plugins

• Host: GitHub
• URL: https://github.com/yetibot/core
• Owner: yetibot
• License: epl-1.0
• Created: 2013-12-17T03:34:00.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-02-08T16:14:35.000Z (about 1 year ago)
• Last Synced: 2024-04-14T04:37:45.667Z (10 months ago)
• Topics: chatbot, clojure, yetibot, yetibot-plugins
• Language: Clojure
• Homepage: https://yetibot.com
• Size: 2.95 MB
• Stars: 25
• Watchers: 10
• Forks: 20
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# yetibot.core

[![Build Status](https://img.shields.io/travis/com/yetibot/yetibot.core?style=for-the-badge)](https://travis-ci.com/yetibot/yetibot.core)

[![Clojars](https://img.shields.io/clojars/v/yetibot/core?style=for-the-badge)](https://clojars.org/yetibot/core)

[![Codecov](https://img.shields.io/codecov/c/github/yetibot/yetibot.core?style=for-the-badge)](https://codecov.io/gh/yetibot/yetibot.core)

[![Deps](https://img.shields.io/badge/dynamic/json.svg?label=deps&url=https%3A%2F%2Fversions.deps.co%2Fyetibot%2Fyetibot.core%2Fstatus.json&query=%24.stats..[%22out-of-date%22]&suffix=%20out%20of%20date&style=for-the-badge&colorB=lightgrey)](https://versions.deps.co/yetibot/yetibot.core)

Core Yetibot utilities, extracted for shared use among Yetibot and its various

plugins. yetibot.core is not meant to be run standalone, but instead used as a

dependency from another project that provides config and optionally other

Yetibot plugins, private or public.

The majority of Yetibot commands live in the [main Yetibot

repo](https://github.com/yetibot/yetibot).

- [CHANGELOG](doc/CHANGELOG.md)

- [yetibot.com](https://yetibot.com)

## Usage

You can depend on this library to build your own Yetibot plugins.

Building your own commands is dead simple. Here's an example command that

adds two numbers:

```clojure

(ns mycompany.plugins.commands.add

  (:require [yetibot.core.hooks :refer [cmd-hook]]))

(defn add-cmd

  "add   # Add two numbers"

  [{[_ n1 n2] :match}] (+ (read-string n1) (read-string n2)))

(cmd-hook #"add" ; command prefix

          #"(\d+)\s+(\d+)" add-cmd)

```

See Yetibot's own [commands](https://github.com/devth/yetibot/tree/master/src/yetibot/commands)

for more complex and diverse examples.

## Dev postgres

To quickly provision a postgresql database to work against, run:

```bash

docker-compose up -d

```

And use the corresponding connection string in config:

```edn

:yetibot-db-url "postgresql://yetibot:yetibot@postgres:5432/yetibot"

```

## Remote REPL

Yetibot runs an embedded nREPL server on port `65432`. Connect to it via:

```

nrepl://localhost:65432

```

Or replace `localhost` with the remote network address.

## yetibot-dashboard

`yetibot-dashboard` is an NPM module that contains static HTML/JS/CSS for the

Yetibot dashboard. It's served by yetibot.core's Ring server. A public example

can be seen at [public.yetibot.com](https://public.yetibot.com).

To update to the latest version run:

```bash

./bin/yetibot-dashboard

```

This downloads the lateset `yetibot-dashboard` from NPM, extracts it, copies the

build into `resources/public` then creates a git commit with the changes.

## Docs

- [User Guide](https://yetibot.com/user-guide/)

- [Dev Guide](https://yetibot.com/dev-guide/)

- [Ops Guide](https://yetibot.com/ops-guide/)

## Change Log

View the [CHANGELOG](doc/CHANGELOG.md).

## License

Copyright © 2013–2019 Trevor C. Hartman

Distributed under the Eclipse Public License version 1.0.