Documentation
¶
Index ¶
- func InitAgentsMD(ctx context.Context, repo drivers.RepoStore, force bool) error
- func InitClaudeCode(ctx context.Context, repo drivers.RepoStore, force bool) error
- func InitCursorRules(ctx context.Context, repo drivers.RepoStore, force bool) error
- func LoadAll(opts Options) (map[string]*Instruction, error)
- type Instruction
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func InitAgentsMD ¶ added in v0.84.0
InitAgentsMD generates tool-agnostic AGENTS.md instruction files from Rill instruction files. The entry point is written to /AGENTS.md. All other instructions (including development.md) are written as skills to /.agents/skills/<name>/SKILL.md. MCP server config is written to /.mcp.json. If force is false, it skips files that already exist. If force is true, it overwrites any existing files.
func InitClaudeCode ¶
InitClaudeCode generates Claude Code instruction files from Rill instruction files. The entry point is written to .claude/CLAUDE.md. All other instructions (including development.md) are written as skills to .claude/skills/<name>/SKILL.md. MCP server config is written to /.mcp.json. If force is false, it skips files that already exist. If force is true, it overwrites any existing files.
func InitCursorRules ¶
InitCursorRules generates Cursor rules files from Rill instruction files. The rules are written to .cursor/rules/ in the repository. If force is false, it skips generation if .cursor/rules/ already exists. If force is true, it overwrites any existing files.
Types ¶
type Instruction ¶
Instruction represents a parsed instruction file with front matter and body.
type Options ¶
type Options struct {
// External indicates whether the instructions are being loaded for external use (e.g., Claude Skills or Cursor rules) or internal use (e.g., Rill's own agents).
External bool
// Memory indicates whether user memory is enabled for the session the instructions are rendered for.
// When false, the sections about the user_memory block and the update_memory tool are omitted.
Memory bool
}
Options configures how instruction files are loaded and rendered.