https://github.com/dahlia/botkit

A framework for creating ActivityPub bots
https://github.com/dahlia/botkit

activitypub bot fedify fediverse

Last synced: 2 days ago
JSON representation

A framework for creating ActivityPub bots

• Host: GitHub
• URL: https://github.com/dahlia/botkit
• Owner: dahlia
• License: agpl-3.0
• Created: 2025-01-07T05:41:20.000Z (12 days ago)
• Default Branch: main
• Last Pushed: 2025-01-16T07:59:14.000Z (3 days ago)
• Last Synced: 2025-01-16T09:02:11.445Z (3 days ago)
• Topics: activitypub, bot, fedify, fediverse
• Language: TypeScript
• Homepage: https://botkit.fedify.dev/
• Size: 1.26 MB
• Stars: 32
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[BotKit] by Fedify

==================

[![GitHub Actions][GitHub Actions badge]][GitHub Actions]

[![Codecov][Codecov badge]][Codecov]

> [!NOTE]

> BotKit is still in early development.  The API may change in the future.

> Although it currently supports only Deno, it will support Node.js and Bun

> later.

[BotKit] is a framework for creating [ActivityPub] bots.  It is powered by

[Fedify], a lower-level library for creating ActivityPub server applications.

Unlike Mastodon bots, BotKit is designed to create a standalone ActivityPub bot,

which is a complete ActivityPub server in itself and not limited to Mastodon's

capabilities (such as the 500-character limit per post).

BotKit's API is so simple and easy to use that you can create a complete bot in

a single TypeScript file.  Here's an example of a simple bot that just greets:

~~~~ typescript

import { createBot, mention, text } from "@fedify/botkit";

import { RedisKvStore } from "@fedify/redis";

import { Redis } from "ioredis";

// Create a bot instance:

const bot = createBot({

  // The bot will have fediverse handle "@greetbot@mydomain":

  username: "greetbot",

  // Set the display name:

  name: "Greet Bot",

  // Set the profile icon (avatar):

  icon: new URL("https://mydomain/icon.png"),

  // Set the bio:

  summary: text`Hi, there! I'm a simple fediverse bot created by ${

    mention("@[email protected]")}.`,

  // Use Redis as a key-value store:

  kv: new RedisKvStore(new Redis()),

  // Use Redis as a message queue:

  queue: new RedisMessageQueue(() => new Redis()),

});

// A bot can respond to a mention:

bot.onMention = async (session, message) => {

  await message.reply(text`Hi, ${message.actor}!`);

};

// Or, a bot also can actively publish a post:

const session = bot.getSession("https://mydomain/");

setInterval(async () => {

  await session.publish(text`Hi, folks! It's an hourly greeting.`);

}, 1000 * 60 * 60);

export default bot;

~~~~

For more information, see the [BotKit docs][BotKit].

[BotKit]: https://botkit.fedify.dev/

[GitHub Actions]: https://github.com/dahlia/botkit/actions/workflows/main.yaml

[GitHub Actions badge]: https://github.com/dahlia/botkit/actions/workflows/main.yaml/badge.svg

[Codecov]: https://codecov.io/gh/dahlia/botkit

[Codecov badge]: https://codecov.io/gh/dahlia/botkit/graph/badge.svg?token=dMbBbQvk4v

[ActivityPub]: https://activitypub.rocks/

[Fedify]: https://fedify.dev/