Skip to content

Configure a project to work with AI coding agents

Source: R/tidy-agents.R
use_tidy_agents.Rd

[Experimental]

This function sets up a project to work with AI coding agents. Specifically, it:

  • Creates an AGENTS.md file containing project-specific instructions for R package development. It includes general development advice, as well as pointers to specific skills provided by learn_tidy_skill().

    This file is read by most coding agents, including Codex, Gemini CLI, and Cursor.

    The file begins with a "This package" section for your own package-specific advice. If you re-run use_tidy_agents() to update AGENTS.md, the contents of this section are preserved.

  • Creates a .claude/ directory to configure Claude Code, which doesn't yet read AGENTS.md:

    • CLAUDE.md imports AGENTS.md, so Claude Code uses the same instructions as other agents.

    • settings.json denies the agent access to sensitive files like .Renviron and .env.

    • .gitignore ignores settings.local.json (for user-specific settings).

  • .Rbuildignore ignores AGENTS.md and .claude/, so they aren't included in your built package.

Usage

use_tidy_agents()

Examples

if (FALSE) { # \dontrun{
use_tidy_agents()
} # }