Events

Browse the events Mergify recorded for the repository

mergify events #

Browse the events Mergify recorded for the repository. List the activity log as a timeline — queue enters and leaves, merges, commands, CI Insights, every event type — for the whole repository or one pull request (--pr). The output always states the time window it covers: the last 24 hours by default, up to the 90 days the log retains (--since 90d), and the newest page of events within it (--limit).

Usage

mergify events [OPTIONS]

Options


      -t, --token
      
           
          <TOKEN>

string

Mergify token. Falls back to MERGIFY_TOKEN, then the credential mergify auth login stored for this API URL, then GITHUB_TOKEN and gh auth token — the last two are deprecated for the Mergify API


      -u, --api-url
      
           
          <API_URL>

string

Mergify API URL. Falls back to MERGIFY_API_URL env var, then to the default


      -r, --repository
      
           
          <REPOSITORY>

string

Repository full name (owner/repo). Falls back to GITHUB_REPOSITORY env var


      --pr
      
           
          <PR_NUMBER>

string

Only events for this pull request; omit to cover the whole repository


      --since
      
           
          <DURATION>

string

How far back to look: an integer with a unit — s, m, h, d or w (e.g. 30m, 12h, 7d). Defaults to 24h; the log retains 90 days (--since 90d is the widest useful window). The window always ends now and is stated in the output


      --type
      
           
          <EVENT_TYPE>

string

Only events of this type (e.g. action.queue.leave). Repeat the flag to match several types; values pass to the API verbatim, so types newer than this CLI work too


      --limit
      
           
          <N>

string

Stop after the newest N events. The default is one API page — a busy repository records thousands of events a day, so fetching the whole window takes minutes. The output says when the cap took effect; raise it to read further back

Default: 100


      --json

flag

Emit a single JSON document (the raw events, newest first, with the queried window echoed) instead of the timeline

Global options


      -v, --verbose

flag

Increase log verbosity: -v info, -vv debug, -vvv trace. Logs go to stderr so stdout stays clean for piping. RUST_LOG overrides this


      --debug

flag

Shorthand for at least debug-level logging (like -vv)


      --color
      
           
          <COLOR>

auto | always | never

When to use color in terminal output

Values: auto always never

Default: auto

Environment variables

MERGIFY_API_URL

Base URL of the Mergify API. An API URL given on the command line or in a reporter's configuration takes precedence.

Default: https://api.mergify.com

MERGIFY_TOKEN

The Mergify credential: an application key in CI. Without it the test reporters upload nothing. A mergify command takes it when --token is not given, over the credential mergify auth login stored, and mergify auth tells when it does. The mergify stack commands send it to GitHub as their GitHub token, ahead of GITHUB_TOKEN, unless it holds a Mergify user token (mut_…).

Was this page helpful?