Skip to contents

Get the conventional agent path for a coding agent

Source: R/agent_path.R
agent_path.Rd

Returns the conventional directory path where custom agents for a given coding agent are stored. The path is not expanded (i.e., ~ is not resolved to the home directory). Use fs::path_expand() if you need an absolute path.

Usage

agent_path(agent = NULL, scope = c("project", "global"))

Arguments

agent

One of "claude_code" (or its alias "claude"), "openclaw", "codex", "cursor", "gemini_cli", "github_copilot" (or its alias "copilot"), or "posit_ai" (or its alias "posit"). If NULL (the default), the agent is resolved in order: (1) the WF_AGENT environment variable, (2) a scan of the current working directory for a recognised agent config folder (.claude, .cursor, etc.), and (3) a final fallback to "claude_code". Set WF_AGENT in your .Renviron (e.g. with usethis::edit_r_environ()) to avoid passing agent every time.

scope

One of "project" (a path relative to the current working directory, suitable for committing to version control) or "global" (a path in the user's home directory, available across all projects).

Value

A length-1 character vector giving the conventional agents path.

Examples

agent_path('claude_code', 'project')
#> [1] ".claude/agents"
agent_path('claude', 'project') # alias for claude_code
#> [1] ".claude/agents"
agent_path('cursor', 'global')
#> [1] "~/.cursor/agents"
agent_path() # auto-detects from WF_AGENT, dir scan, or falls back to claude_code
#> [1] ".claude/agents"