ghqc

The ghqc R package is a lightweight wrapper that installs and runs the ghqctoolkit CLI binary, which provides a web UI for managing QC through GitHub Issues and Milestones.

For more information about ghqc, refer to the README of ghqctoolkit. Updates to the documentation website are ongoing.

Installation

# install.packages("pak")
pak::pak("a2-ai/ghqc")

Getting Started

1. Install the ghqc binary

The ghqc R package is a wrapper around the ghqctoolkit binary. Install it with:

ghqc::ghqc_install()

This downloads the appropriate binary for your platform and adds its install directory to your PATH for the current R session. On Linux and macOS the binary is installed to ~/.local/bin; on Windows it is installed to %LOCALAPPDATA%/Programs/ghqc.

If ghqc is already installed, ghqc_install() will compare your local version against the latest GitHub release and prompt you to upgrade if a newer version is available.

You can also install a specific release:

ghqc::ghqc_install(version = "v0.4.1")

2. Launch the ghqc UI

ghqc::ghqc()

This starts the ghqc web UI as a supervised background process and opens it in your browser. Any previously running ghqc server is stopped first. The launched server URL is discovered at startup and stored for later status checks and reconnection, rather than assuming localhost.

You can optionally specify a port or a custom configuration directory:

# Start on a specific port
ghqc::ghqc(port = 8080)

# Start for a specific directory with a custom config location
ghqc::ghqc(directory = "analysis", config_dir = "~/.config/ghqc")

Managing the Server

# Check whether the server is running and get its URL
ghqc::ghqc_status()

# Reopen the browser tab using the stored server URL without restarting
ghqc::ghqc_reconnect()

# Stop the running server
ghqc::ghqc_stop()

Version Information

# Get the locally installed binary version
ghqc::ghqc_version()

# Get the latest release version from GitHub
ghqc::ghqc_remote_version()

Diagnostics

# Print a situation report: binary, server status, git repo, and milestones
ghqc::ghqc_sitrep()

# Include configuration details (checklists, options)
ghqc::ghqc_sitrep(with_configuration = TRUE)