framework docs
AI

ai_generate_context()

Generate AI Context File

Generates the canonical AI context file (AGENTS.md) for a project. The file is intentionally thin: it carries project-specific facts (environment, packages, directories) plus an index of the Framework skills installed in .claude/skills/, which hold the detailed workflow instructions.

Usage

ai_generate_context(
  project_path = ".",
  project_name = NULL,
  project_type = NULL,
  config = NULL
)

Arguments

project_path
Path to the project directory (default: current directory)
project_name
Name of the project (for header)
project_type
Project type: "project", "project_sensitive", "course", "presentation"
config
Project configuration (if NULL, reads from settings.yml)

Value

Character string with the complete AI context content

Examples

if (FALSE) {
# Generate AI context for current project
content <- ai_generate_context()
# Generate for a specific project type
content <- ai_generate_context(project_type = "project_sensitive")
}