guildgate-doctor

The doctor command inspects GuildGate settings and the project environment. It does not modify source files.

Help

npx guildgate-doctor --help

Usage: guildgate-doctor [options]

Checks GuildGate security, storage, analytics and production settings.

Options:
  --json      Print machine-readable JSON output.
  -h, --help  Show this help message.

Normal output

npx guildgate-doctor

Human-readable output shows each check and its status. Failed checks produce a non-zero process exit code, which CI should use.

JSON output

npx guildgate-doctor --json > guildgate-doctor.json

The JSON result can be retained as a deployment artifact or evaluated in a pipeline policy step. Review environment paths and configuration details before publishing it to public logs.

Check areas

Depending on the version and available files, doctor covers groups such as:

• production URL and origin security
• cookie and session bounds
• store capabilities and adapter contract
• transaction and audit configuration
• Redis and PostgreSQL selection
• realtime and analytics bounds
• release and package metadata

A successful doctor run does not by itself prove live PostgreSQL or Redis connectivity or application-specific Discord authorization. Run service-integration and application tests in CI as well.

CI usage

- name: GuildGate doctor
  run: npx guildgate-doctor --json

Run it after deployment environment variables are available. Do not pass secret values as command-line arguments.

Troubleshooting

1. Fix the first failed check.
2. Verify production and staging environment files are not mixed.
3. Check the GuildGate version in package-lock.json.
4. For custom stores, inspect runStoreContract() results.
5. Run doctor again with the same environment.