Skip to contents

Create a new agent template

Source: R/init_agent.R
init_agent.Rd

Creates a new agent file at path/name.md containing a template ready to be filled in.

Usage

init_agent(name, path = NULL)

Arguments

name

Agent name. Must be 1-64 characters, lowercase alphanumeric with single hyphens (no consecutive --), and cannot start or end with a hyphen. Consider using a gerund or role form (e.g. "code-reviewer", "test-writer").

path

Directory in which to create the agent file. Can be one of:

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

  • 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

The path to the new agent file, invisibly.

Examples

init_agent('my-agent', tempfile())
#> Created agent "my-agent" at /tmp/Rtmp1p0v0x/file1be5793fbb34/my-agent.md.