Skip to contents

Install a skill

Source: R/add_skill.R
add_skill.Rd

Installs a skill from a GitHub repository or a local directory into a skills directory.

Usage

add_skill(source, skill = NULL, path = NULL, overwrite = FALSE)

Arguments

source

One of:

  • A GitHub URL pointing to a repo, e.g. "https://github.com/owner/repo".

  • A GitHub URL pointing to a subdirectory, e.g. "https://github.com/owner/repo/tree/main/path/to/skill".

  • A GitHub shorthand, e.g. "owner/repo".

  • A local directory path containing a SKILL.md file.

skill

The skill to install. One of:

  • A bare skill name, e.g. "proofread". The skill is read from skills/<skill> within the repository.

  • A path to the skill directory, e.g. "r-lib/mirai" or "r-lib/mirai/". Used directly as the subdirectory path.

  • A path to the SKILL.md file, e.g. "r-lib/mirai/SKILL.md". The filename is stripped and the containing directory is used. Ignored when source already points to a specific subdirectory via /tree/... or /blob/....

path

The skills directory. Can be one of:

  • A known coding agent name such as 'claude_code', 'cursor', or 'github_copilot' (see skill_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.

overwrite

If FALSE (the default), an error is raised if the skill is already installed. Set to TRUE to replace it.

Value

The path to the installed skill directory, invisibly.

Examples

src <- tempfile()
dir.create(src)
writeLines(
  c('---', 'name: example', 'description: An example skill.', '---'),
  file.path(src, 'SKILL.md')
)
add_skill(src, path = tempfile())
#> Installed skill "example" to /tmp/Rtmplehrfy/file196d3ad8c1eb/example.