agentdocs

package
v0.20.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 9, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package agentdocs installs the release-owned Ridu skill bundle into generated and existing projects without overwriting user-authored instructions.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Definition 

type Definition struct {
	Selection   Selection
	Description string
}

Definition is stable CLI-facing metadata for one agent selection.

func Definitions 

func Definitions() []Definition

Definitions returns selections in their user-facing display order.

type Result 

type Result struct {
	Written             []string
	PreservedEntrypoint []string
	// Excluded lists skills a sync found deleted and recorded as opted out.
	Excluded         []string
	FrameworkVersion string
	ManagedFiles     int
}

Result describes an installation or synchronization without exposing internal ownership metadata.

func Install 

func Install(root string, selection Selection, frameworkVersion string) (Result, error)

Install adds an agent layout to an existing project. Existing root instructions are preserved, and unmanaged skill files are never replaced.

func InstallNewProject 

func InstallNewProject(root string, selection Selection, frameworkVersion string) (Result, error)

InstallNewProject installs agent docs into a new scaffold staging directory. The caller guarantees that the directory is not user-owned yet.

func Sync 

func Sync(root, frameworkVersion string) (Result, error)

Sync updates every framework-owned skill file recorded by the project. It refuses the complete operation if any managed file was edited by the user.

type Selection 

type Selection string

Selection identifies the coding-agent layout installed into a project. 

const (
	SelectionCodex  Selection = "codex"
	SelectionClaude Selection = "claude"
	SelectionCursor Selection = "cursor"
	SelectionAll    Selection = "all"
	SelectionNone   Selection = "none"
)

func DetectSelection added in v0.16.0 

func DetectSelection(getenv func(string) string) Selection

DetectSelection reports the coding agent running the CLI from its environment, or "" when none is recognized. Claude Code sets CLAUDECODE in the commands it runs and discovers skills only under .claude/skills, so a project it creates without an explicit selection needs its layout.

func ParseSelection 

func ParseSelection(value string) (Selection, error)

ParseSelection validates a CLI-facing selection. Empty selects the default Codex project layout.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.