quay remote

Manage the hub remotes in this project's .quay/config.toml. add, edit and remove write that file, so run quay init first.

Usage

quay remote <SUBCOMMAND>

Subcommands:

SubcommandWhat
addRegister a new remote (<NAME> <URL>).
listShow every remote with provider + push_mode + default marker.
testRun a connectivity probe (git archive or shallow clone).
editChange a remote's URL, provider, push mode, direct branch, or default flag (<NAME>).
removeDelete a remote from the project config.

Examples

quay remote add main git@github.com:corp/skills.git --provider github --default
quay remote add personal git@gitlab.com:me/skills.git --provider gitlab --push-mode pr
quay remote list
quay remote test main
quay remote remove personal

add flags

FlagEffect
--defaultMark as the default remote.
--provider <KIND>Force provider: github / githubenterprise / gitlab / bitbucket / azuredevops. Auto-detected from URL if omitted.
--push-mode <pr|direct>Default push mode for this remote (default: pr).
--direct-branch <BRANCH>Target branch for direct-mode pushes (on edit, "" clears it).
--profile, --user-config, --project, --jsonStandard globals.

When to use this vs …

  • quay profile add … --remote — seeds remotes during profile creation. Use remote add afterwards.
  • quay rebuild-registry <name> — recovery flow when a hub's registry.json is broken.

remote test

Two-step probe:

  1. git archive --remote=<URL> HEAD -- registry.json (cheap; no clone).
  2. If archive fails, shallow-clone (--depth 1) into a temp dir and look for registry.json.

Exits 0 on success, non-zero on either failure with a diagnostic message identifying which step failed. Useful in CI before quay add to fail fast on bad URLs / missing creds.

Caveats

  • A gitlab URL that points at a GitLab Enterprise instance still works; the provider only affects PR creation, not git clone.
  • Removing the default remote leaves the project config with no default (a default from your profile still applies, if it has one). Otherwise the next push must use --remote.
  • test will not catch every authentication issue (e.g. SSH known_hosts prompts) — if it succeeds but push fails, suspect agent forwarding / known_hosts.

--help (top level)

Manage configured hub remotes

Usage: quay remote [OPTIONS] <COMMAND>

Commands:
  add     Add a new remote
  test    Test connectivity to a configured remote
  list    List configured remotes
  remove  Remove a remote
  edit    Edit an existing remote
  help    Print this message or the help of the given subcommand(s)