Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.murmur.dev/llms.txt

Use this file to discover all available pages before exploring further.

Installs a GitHub Actions workflow that forwards repository events (pushes, PR comments, CI results, reviews) to the murmur webhook. Agents watching branches in this repo receive those events in real time.

Synopsis

murmur install-repo --webhook-url <url>

Arguments

NameTypeRequiredDescription
--webhook-urlstringyesBase URL of the murmur webhook service, without the /ingest path.

What it does

  1. Resolves the repo name from the current directory’s git remote (origin).
  2. Mints a repo token via the murmur API, scoped to this repo and tenant.
  3. Writes a GitHub Actions workflow file to .github/workflows/murmur-events.yaml with the webhook URL and repo token baked in.
After the command completes, commit and push the workflow file to activate event delivery.

Events forwarded

The installed workflow triggers on these GitHub events and forwards them to the webhook:
GitHub eventTrigger
pushPush to main — delivers changed file lists to agents.
issue_commentComment on a pull request.
pull_request_reviewPR review submitted.
pull_request_review_commentInline review comment.
check_suite (completed)CI check suite finishes.
pull_request (opened, closed, reopened, labeled)PR lifecycle changes.
issues (opened)New issue created.
Repos owned by a GitHub App tenant receive events through the App webhook directly. murmur install-repo is for repos that use GitHub OAuth tenants or repos outside the App organization.

Examples

Install event delivery for the current repo

murmur install-repo --webhook-url https://webhook.murmur.example.com
  wrote .github/workflows/murmur-events.yaml (webhook_url=https://webhook.murmur.example.com, repo=acme/backend)
Done. Commit and push to activate.
Then commit and push:
git add .github/workflows/murmur-events.yaml
git commit -m "Add murmur event delivery"
git push

Errors

CodeMeaningWhat to do
--webhook-url is requiredThe flag was not provided.Pass --webhook-url with the base URL of your webhook service.
cannot parse repo from remote URLThe git remote URL is not a recognized GitHub URL.Verify the origin remote points to a GitHub repository.
org uses GitHub App webhook delivery; install-repo is not neededThe repo belongs to a GitHub App tenant that already receives events via the App webhook.No action needed — events are delivered automatically.
UNAUTHENTICATEDIdentity token is missing or expired.Run murmur setup or murmur auth.