Skip to contents

Print a situation report for ghqc and the current project

Source: R/sitrep.R
ghqc_sitrep.Rd

Collects and displays diagnostic information about the ghqc binary, the currently running ghqc background server (if any), and the git repository for the given directory (owner, repo, branch, and milestones). It also reports authentication state for the repository host. Optionally it reports on the ghqc configuration (checklists, options, etc.).

Usage

ghqc_sitrep(
  directory = here::here(),
  config_dir = NULL,
  with_configuration = FALSE
)

Arguments

directory

Path to the project directory. Defaults to the project root as determined by here::here().

config_dir

Path to the ghqc configuration directory. If NULL (default), ghqc uses its default configuration discovery logic.

with_configuration

Logical. If TRUE, include a section describing the ghqc configuration (checklists, options). Defaults to FALSE.

Value

The raw sitrep data list returned by ghqc sitrep --json, invisibly. The primary purpose of this function is its printed output.

Examples

if (FALSE) { # \dontrun{
# Basic sitrep
ghqc_sitrep()

# Include configuration details
ghqc_sitrep(with_configuration = TRUE)
} # }