Skip to content

williamhzo/sentinel

Repository files navigation

Sentinel

Monitor changelogs for your favouritte tools & libraries, and get notified in Telegram.

Can be used for any tool or library, currently set up for the following:

  • Claude Code
  • Vercel AI SDK
  • Cursor IDE
  • v0
  • AI Elements
  • wagmi
  • viem

Setup

1. Install Dependencies

bun install

2. Create Telegram Bot

  1. Message @BotFather on Telegram
  2. Send /newbot and follow prompts
  3. Save the bot token from the response

3. Get Chat ID

  1. Start a chat with your bot
  2. Send any message to your bot
  3. Visit: https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates
  4. Find "chat":{"id": in the response

4. Set Environment Variables

In .env:

TELEGRAM_TOKEN=your_bot_token
CHAT_ID=your_chat_id

Usage

Local/Development:

bun run sentinel.ts

Cloudflare Worker:

wrangler deploy

Adding New Tools

To monitor a new tool's changelog:

  1. Add config in changelog-checks.ts:

    NEWTOOL: {
      url: 'path_to_raw_markdown_or_deployed_changelog',
      link: 'path_to_changelog',
      name: 'tool name',
    }
  2. Create checker (use createChangelogChecker for markdown or write custom function for HTML):

    export const checkNewTool = createChangelogChecker(
      CONFIG.NEWTOOL,
      'newtool'
    );
  3. Add to checks in sentinel.ts runChecks() function

Testing

bun test

About

Monitor changelogs for your favouritte tools & libraries, and get notified in Telegram.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published