README.md

mastodon-auto-reply-bot

A Mastodon Bot to automatically reply to statuses that match the given filters.

Run

Docker Compose

Use docker-compose.yml.

Local

git clone https://github.com/ouuan/mastodon-auto-reply-bot
cd mastodon-auto-reply-bot
pnpm i
pnpm build
node .

Config

See schema.ts for config schema.

See Status - Mastodon documentation and Status | masto for the Status object used in filters.

Example config.yml:

url: https://mastodon.social/
streamingApiUrl: wss://mastodon.social/
accessToken: TOKEN
rules:
  - filters:
      - path: content  # path in the Status API entity
        type: string
        match: bot
      - path: tags
        type: array
        contains:  # array contains subfilters
          - path: name
            type: string
            match: auto-reply
    reply: Hello! I'm an auto-reply bot.
    at: false  # no @username in the reply
  - filters:
      - path: content
        type: string
        match: '[Hh]ello'  # regular expression
      - path: visibility
        invert: true  # reply only when the condition is not met
        type: string
        match: private
      - path: account.followersCount
        type: number
        min: 1
        max: 5
      - path: account.bot
        type: boolean
        is: false
      - path: inReplyToId
        type: 'null'
    reply: Nice to meet you!
    visibility: direct  # the visibility of the reply