Skip to main content

Module prerequisites

Module prerequisites 

Source
Expand description

Prerequisites checking for RepoLens initialization

This module verifies that required tools and configurations are available before running RepoLens commands.

Structs§

CheckOptions
Options for running prerequisite checks
CheckResult
Result of a single prerequisite check
PrerequisitesReport
Aggregated report of all prerequisite checks

Enums§

CheckLevel
Level of importance for a prerequisite check
CheckStatus
Status of a prerequisite check

Functions§

check_gh_authenticated
Check if GitHub CLI is authenticated
check_gh_installed
Check if GitHub CLI (gh) is installed
check_git_installed
Check if git is installed
check_github_auth_available
Check if any GitHub authentication method is available Returns Ok if either GITHUB_TOKEN is set or gh CLI is authenticated
check_github_token
Check if GITHUB_TOKEN environment variable is set
check_is_git_repo
Check if the current directory is a git repository
check_remote_is_github
Check if the remote origin is a GitHub repository
check_remote_origin
Check if a remote origin is configured
display_error_summary
Display error summary for failed required checks
display_report
Display the full prerequisites report
display_warnings
Display warnings for failed optional checks
get_repo_info
Get repository info (owner/name) from GitHub CLI
is_gh_available
Check if gh CLI is available and authenticated
is_github_auth_available
Check if any GitHub authentication method is available Returns true if GITHUB_TOKEN is set or gh CLI is authenticated
is_github_token_available
Check if GITHUB_TOKEN environment variable is set
run_all_checks
Run all prerequisite checks