Auth

Sign in to Mergify, and manage the stored credential

mergify auth login #

Sign in to Mergify and store the credential. Prints a URL and a code: open the one, enter the other, and approve. The credential lands in your OS keychain, or in a 0600 file when the machine has no keychain to offer.

Usage 
mergify auth login [OPTIONS]
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

-u, --api-url <API_URL> string

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

mergify auth logout #

Revoke the stored credential and forget it. Tells the Mergify API to revoke the token as well as deleting the local copy, so a machine you are handing back stops being signed in everywhere.

Usage 
mergify auth logout [OPTIONS]
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

-u, --api-url <API_URL> string

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

mergify auth status #

Show whether this machine is signed in to Mergify. Names the account, where the credential is stored, and when it runs out. Checks the credential against the API rather than trusting the local copy, so one revoked from the dashboard is reported as invalid.

Usage 
mergify auth status [OPTIONS]
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

-u, --api-url <API_URL> string

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

Was this page helpful?