NAME

repomatic setup-guide - Manage setup guide issue lifecycle

SYNOPSIS

repomatic setup-guide [OPTIONS]

DESCRIPTION

Manage the setup guide issue lifecycle.

Each setup step is shown as a collapsible section with a status indicator: incomplete steps are expanded with a warning emoji, completed steps are collapsed with a checkmark.

PAT availability is auto-detected from the REPOMATIC_PAT environment variable when --has-pat/--no-has-pat is not specified.

When a PAT is detected and --repo is provided, the command runs granular PAT permission checks and repository settings checks. The issue closes only when all verifiable steps pass.

Requires the gh CLI to be authenticated.

OPTIONS

--has-cloudflare-api-token: Whether CLOUDFLARE_API_TOKEN is configured.
--has-notifications-pat: Whether REPOMATIC_NOTIFICATIONS_PAT is configured.
--has-pat / --no-has-pat: Whether REPOMATIC_PAT is configured, enabling the PAT capability checks. Auto-detected from the REPOMATIC_PAT environment variable when omitted.
--has-virustotal-key: Whether VIRUSTOTAL_API_KEY is configured.
--repo TEXT: Repository in 'owner/repo' format. Defaults to $GITHUB_REPOSITORY.
--help / -h: Show this message and exit.

ENVIRONMENT

HAS_CLOUDFLARE_API_TOKEN: Whether CLOUDFLARE_API_TOKEN is configured.
SETUP_GUIDE_HAS_CLOUDFLARE_API_TOKEN: Whether CLOUDFLARE_API_TOKEN is configured.
HAS_REPOMATIC_NOTIFICATIONS_PAT: Whether REPOMATIC_NOTIFICATIONS_PAT is configured.
SETUP_GUIDE_HAS_NOTIFICATIONS_PAT: Whether REPOMATIC_NOTIFICATIONS_PAT is configured.
SETUP_GUIDE_HAS_PAT: Whether REPOMATIC_PAT is configured, enabling the PAT capability checks. Auto-detected from the REPOMATIC_PAT environment variable when omitted.
HAS_VIRUSTOTAL_API_KEY: Whether VIRUSTOTAL_API_KEY is configured.
SETUP_GUIDE_HAS_VIRUSTOTAL_KEY: Whether VIRUSTOTAL_API_KEY is configured.
GITHUB_REPOSITORY: Repository in 'owner/repo' format. Defaults to $GITHUB_REPOSITORY.
SETUP_GUIDE_REPO: Repository in 'owner/repo' format. Defaults to $GITHUB_REPOSITORY.
SETUP_GUIDE__CLICK_DEFAULT_HELP: Show this message and exit.

EXIT STATUS

0: Success.
1: A runtime error, or an aborted prompt (Ctrl-C, a declined confirmation).
2: A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.

EXAMPLES

No secret: create or reopen the setup issue

repomatic setup\-guide

Secret configured: close the issue if all checks pass

repomatic setup\-guide \-\-has\-pat

AUTHORS

Kevin Deldycke