Skip to contents

Check installed agents for available updates

Source: R/check_agents.R
check_agents.Rd

Compares each installed agent's recorded commit SHA against the latest commit on GitHub. Local agents are reported as not updatable.

Usage

check_agents(path = NULL)

Arguments

path

The agents directory. Can be one of:

  • A known coding agent name such as 'claude_code', 'cursor', or 'github_copilot' (see agent_path() for the full list) to use that agent's conventional project-scope path.

  • A character string giving the directory path directly.

  • NULL (the default), in which case the path is resolved from the WF_AGENT environment variable, or by prompting in interactive sessions. Set WF_AGENT in your .Renviron (e.g. with usethis::edit_r_environ()) to avoid the prompt.

Value

A data frame with columns:

  • name: agent name.

  • installed_sha: the SHA recorded at install time (NA for local).

  • latest_sha: the current HEAD SHA on GitHub (NA for local or on network failure).

  • update_available: TRUE if installed and latest SHAs differ.

Examples

check_agents(tempfile())
#>      name installed_sha latest_sha update_available
#> 1 example          <NA>       <NA>            FALSE