Skip to content
Documentation

Everything you need to get up and running

Link GitHub, register a repo, and turn on trackers. All configuration commands require Administrator and reply privately.

Getting started

Five minutes, four steps, zero YAML. Everything is a slash command with autocomplete.

  1. 01

    Add ForgeFeed

    Invite the bot to your Discord server. It runs with minimal permissions and never reads message content.

  2. 02

    Link GitHub

    An admin installs the GitHub App on their account or org, then finishes with a one-time code. No passwords or tokens.

    /linkgithub → /confirmlink
  3. 03

    Register a repo

    Register a repository once so trackers can select it everywhere via autocomplete.

    /trackrepo repo_url: owner/repo
  4. 04

    Enable trackers

    Point commits, PRs, issues, workflows, releases, and stars at any channel. Updates start flowing in real time.

    /postcommits · /trackprs · …

Core concepts

Four ideas explain how everything fits together.

Linked installation

ForgeFeed authenticates as a GitHub App. Each server links one or more installations: a personal account and/or organizations. Every installation carries its own 5,000 requests/hour quota and only the repositories you grant.

Tracked repository

Before attaching trackers, you register a repo once with /trackrepo. This makes it selectable everywhere via autocomplete.

Tracker

A tracker connects a repository, event type, and channel. For example, “post commits for acme/app to #dev.” A single repo can have unlimited trackers.

Plan

Each server is Free or Premium. The plan controls how many accounts you can link, whether organizations are allowed, and how many repositories you can track. Tracker types and counts are always unlimited.

Command reference

Access levels: Admin requires Administrator, Role requires an allowed role, Owner is bot-owner only, and All is anyone.

AdminRoleOwnerAll

Linking & setup

Connect GitHub and manage which accounts a server can use.

CommandAccessDescription
/linkgithubAdminGet the GitHub App install link; lists linked accounts and your plan.
/confirmlinkAdminFinish linking by pasting the one-time code (pop-up or code argument).
/unlinkgithubAdminRemove all GitHub links from this server.

Repositories

Register the repositories your trackers can attach to.

CommandAccessDescription
/trackrepoAdminRegister a repository (owner/repo or URL) so trackers can use it.
/listreposAdminList registered repositories and plan usage.
/untrackrepoAdminUnregister a repository.
/trackingstatusAdminShow which trackers are on or off per repository.

Event trackers

Turn feeds on and off. Types and counts are always unlimited.

CommandAccessDescription
/postcommitsAdminPost commits to a channel on every push.
/removecommitsAdminRemove a commit tracker.
/trackprsAdminPost pull-request activity (plus optional reviews).
/removeprsAdminRemove a PR tracker.
/trackissuesAdminMaintain a live issue board embed.
/removeissuesAdminRemove an issue tracker (optionally delete the embed).
/postworkflowsAdminPost CI/CD run results (simple or detailed).
/removeworkflowsAdminRemove a workflow tracker.
/trackreleasesAdminPost release announcements.
/removereleasesAdminRemove a release tracker.
/trackstarsAdminPost star (and optional fork) notifications.
/removestarsAdminRemove a star/fork tracker.

Project boards

Curate a public-facing status and progress tracker.

CommandAccessDescription
/createprojecttrackAdminCreate a project status board.
/setprojecttrackAdminAdd or update a project entry (status, %, summary, website).
/setprogressAdminUpdate one project's status or percent.
/setallprogressAdminUpdate every project on a board at once.
/removeprojecttrackAdminDelete a project board.

Issue submission

Let trusted members file GitHub issues from Discord.

CommandAccessDescription
/submitissueRoleOpen a GitHub issue from Discord via a form.
/allow_role_submit_issueAdminGrant or revoke a role's ability to submit issues.
/set_issue_receipt_channelAdminChoose where issue-submission receipts post.
/set_issue_resolved_channelAdminChoose where resolved-issue notices post.

Account & utility

Alerts, plan details, and help.

CommandAccessDescription
/set_rate_alertsAdminConfigure low-rate-limit alerts (channel, threshold, roles).
/planAdminShow plan, repo limit, and active tracker counts.
/helpAllCommand reference.
/setpremiumOwnerSet a server's plan and repo limit (operator tool).

Heads up: all configuration commands require the Administrator permission and reply privately (ephemerally). /submitissue is the only non-admin command and is gated to roles you allow.

See features in action

Ready to link your first repo?

Add ForgeFeed, run /linkgithub, and you'll have live embeds flowing in minutes.

Add to DiscordRead the docs