read/

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ActiveMemory/ctx

Links

Open Source Insights

README ¶

assets/read/

Domain accessor packages for the embedded assets.FS.

Each sub-package owns a slice of the embedded filesystem and exposes it through clean, domain-named functions (e.g., entry.List(), claude.Md()). This avoids a god-object assets package where every function is prefixed with its domain (assets.EntryList, assets.ClaudeMd).

Why this directory exists

assets.FS must live in internal/assets/ (Go //go:embed constraint).
Domain packages here import assets.FS - the dependency flows one way.
assets must never import packages under read/ (that creates a cycle).
Tests in package assets cannot import read/ packages for the same reason; they use assets.FS directly.

Adding a new domain package

Create read/<domain>/<domain>.go
Import assets.FS and config/asset for path constants
Export functions named from the domain's perspective: List(), ForName(), Content() - not DomainList(), DomainContent()
Callers read as entry.List(), claude.Md(), agent.CopilotInstructions()

Do not

Flatten these packages into assets - that's the opposite direction
Delete this directory - the structure is intentional
Import read/ packages from internal/assets/*.go - cycle

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
agent Package agent provides access to agent integration files embedded in the assets filesystem.	Package agent provides access to agent integration files embedded in the assets filesystem.
catalog Package catalog lists available context template files from the embedded assets.	Package catalog lists available context template files from the embedded assets.
claude Package claude provides access to Claude Code integration files embedded in the assets filesystem.	Package claude provides access to Claude Code integration files embedded in the assets filesystem.
desc Package desc provides command, flag, text, and example description lookups backed by embedded YAML.	Package desc provides command, flag, text, and example description lookups backed by embedded YAML.
entry Package entry provides access to entry template files embedded in the assets filesystem.	Package entry provides access to entry template files embedded in the assets filesystem.
hook Package hook provides access to hook message templates and the hook registry from embedded assets.	Package hook provides access to hook message templates and the hook registry from embedded assets.
journal Package journal provides access to journal site assets such as extra CSS.	Package journal provides access to journal site assets such as extra CSS.
lookup Package lookup owns the YAML description maps and eager initialization for all embedded text lookups.	Package lookup owns the YAML description maps and eager initialization for all embedded text lookups.
loop Package loop provides access to Ralph autonomous loop templates from embedded assets.	Package loop provides access to Ralph autonomous loop templates from embedded assets.
makefile Package makefile provides access to the embedded Makefile.ctx template.	Package makefile provides access to the embedded Makefile.ctx template.
philosophy Package philosophy provides access to embedded why-documents (manifesto, about, design invariants).	Package philosophy provides access to embedded why-documents (manifesto, about, design invariants).
project Package project provides access to project-root files and directory README templates from embedded assets.	Package project provides access to project-root files and directory README templates from embedded assets.
prompt Package prompt provides access to embedded prompt templates for code review, refactoring, and explanation.	Package prompt provides access to embedded prompt templates for code review, refactoring, and explanation.
schema Package schema provides access to the embedded JSON Schema for `.ctxrc` validation.	Package schema provides access to the embedded JSON Schema for `.ctxrc` validation.
skill Package skill provides access to embedded skill directories, SKILL.md files, and reference documents.	Package skill provides access to embedded skill directories, SKILL.md files, and reference documents.
template Package template provides access to context template files (TASKS.md, DECISIONS.md, etc.) from embedded assets.	Package template provides access to context template files (TASKS.md, DECISIONS.md, etc.) from embedded assets.