Skip to contents

Run the ghqc UI as a background job

Source: R/ghqc.R
ghqc.Rd

Starts the ghqc web UI as a supervised background R process and opens it in the browser. Any previously running ghqc server is stopped first. Use ghqc_stop() to stop the server, ghqc_status() to check its status, or ghqc_reconnect() to reopen the browser tab without restarting the server.

Usage

ghqc(
  directory = here::here(),
  port = NULL,
  config_dir = NULL,
  ipv4_only = FALSE,
  log_level = Sys.getenv("GHQC_LOG_LEVEL", "TRACE")
)

Arguments

directory

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

port

Integer port to bind the server to. If NULL (default), a random available port is selected automatically.

config_dir

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

ipv4_only

Force IPv4-only bind and loopback URL

log_level

Level of logging the server runs with. Recommended to leave as TRACE since ghqc_log() will filter levels.

Value

Called for its side effect of starting the server and opening the browser. Returns NULL invisibly.

Examples

if (FALSE) { # \dontrun{
# Start with defaults (project root, random port)
ghqc()

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

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