Cage is a cli application for detecting unfollowers on any social services. this application will check all of your followers using each watcher and compare them to the previous check. if there is a difference, it will notify you of the changes.
$ npm install -g cage-cli@dev
$ cage --help
Usage: cage [options]
(almost) realtime unfollower detection for any social services π¦βοΈπ
Options:
-c, --config <path> path to the configuration file (default: "./config.json")
-d, --database <path> path to the database file (default: "./data.sqlite")
-p, --drop-database delete the old database file
-v, --verbose enable verbose level logging
-V, --version output the version number
-h, --help display help for command
or you can just deploy with docker
if you want:
$ docker run -d --name cage async3619/cage -v /path/to/config.json:/home/node/config.json
of course, you can also use docker-compose
:
version: "3.9"
services:
cage:
image: async3619/cage
volumes:
- /path/to/config.json:/home/node/config.json
Watchers
are independent feature that has the ability to watch to check users who follow your account per service.
Service | Support? |
---|---|
β | |
GitHub | β |
Mastodon | β |
β | |
TikTok | β |
YouTube | β |
Twitch | β |
β | |
β | |
Discord | β |
When we detect unfollowers, new followers, or any other events, Cage will notify you via Notifiers
.
Service | Support? |
---|---|
Discord Webhook | β |
Telegram Bot | β |
Slack Webhook | β |
β | |
SMS | β |
this application reads configuration file from ./cage.config.json
by default.
if there's no configuration file to read, this application will create you a default configuration file for you:
{
"watchInterval": 60000,
"watchers": {},
"notifiers": {}
}
you can use json schema file config.schema.json
on this repository.
specify watching interval in millisecond format. minimal value is 60000
.
{
"type": "twitter", // required
"bearerToken": "bearer token of your twitter app" // string, required
}
watcher configuration for GitHub service.
{
"type": "github", // required
"authToken": "personal access token of your github account" // string, required
}
notifier configuration for Discord Webhook notifier.
{
"type": "discord",
"webhookUrl": "Discord Webhook url" // string, required
}
notifier configuration for Telegram Bot notifier.
{
"type": "telegram",
"botToken": "token that generated from https://t.me/CageNotifierBot", // string, required
"url": "custom notification relay server url" // string, optional
}
In most cases, you will not need url
property since since Cage already provides hosted version of this server out of the box. but if you want to use custom notification relay server, take a look this repoitory.
notifier configuration for Slack Webhook notifier.
{
"type": "slack",
"webhookUrl": "Slack Webhook url" // string, required
}