Directories
¶
| Path | Synopsis |
|---|---|
|
Package acl provides principal-aware authorization for entity and relation writes.
|
Package acl provides principal-aware authorization for entity and relation writes. |
|
Package aclaudit is an on-demand linter for an acl.Policy loaded from `acl.yaml`.
|
Package aclaudit is an on-demand linter for an acl.Policy loaded from `acl.yaml`. |
|
Package aclmap materializes slices of the effective-access relation — who can perform a verb on an entity, and by which route — from the declarative ACL policy plus the graph.
|
Package aclmap materializes slices of the effective-access relation — who can perform a verb on an entity, and by which route — from the declarative ACL policy plus the graph. |
|
Package affordances builds a policy-driven field/option/relation affordance resolver from an acl.yaml acl.Policy.
|
Package affordances builds a policy-driven field/option/relation affordance resolver from an acl.yaml acl.Policy. |
|
Package ai provides LLM access for rela via OpenAI-compatible providers.
|
Package ai provides LLM access for rela via OpenAI-compatible providers. |
|
Package analysis exposes the read-only analysis facades the CLI uses to surface graph health: orphans, duplicates, gaps, cardinality violations, custom Lua validations, and orphan temp files left by interrupted writes.
|
Package analysis exposes the read-only analysis facades the CLI uses to surface graph health: orphans, duplicates, gaps, cardinality violations, custom Lua validations, and orphan temp files left by interrupted writes. |
|
apiwire
|
|
|
v1
Package v1 holds the v1 data-entry API wire vocabulary: the JSON-shaped request/response types the server serializes to and that an in-process native bridge can consume directly.
|
Package v1 holds the v1 data-entry API wire vocabulary: the JSON-shaped request/response types the server serializes to and that an in-process native bridge can consume directly. |
|
Package app provides factories that construct the concrete services needed by each rela entry point (cli, data-entry server, desktop, MCP).
|
Package app provides factories that construct the concrete services needed by each rela entry point (cli, data-entry server, desktop, MCP). |
|
Package appbuild assembles the focused services every project entry point (rela-server, rela-desktop, future bindings) needs from a project directory.
|
Package appbuild assembles the focused services every project entry point (rela-server, rela-desktop, future bindings) needs from a project directory. |
|
appbuildtest
Package appbuildtest provides a test fixture for assembling an appbuild.Services bundle.
|
Package appbuildtest provides a test fixture for assembling an appbuild.Services bundle. |
|
backendtest
Package backendtest supplies the backend a build-agnostic wiring test needs.
|
Package backendtest supplies the backend a build-agnostic wiring test needs. |
|
Package attachment exposes the CLI-shaped facade for managing entity file attachments (attach, list).
|
Package attachment exposes the CLI-shaped facade for managing entity file attachments (attach, list). |
|
Package audit records every entity and relation write performed by the project as an append-only JSONL stream.
|
Package audit records every entity and relation write performed by the project as an append-only JSONL stream. |
|
Package autocascade executes the side effects of automation results produced by automation.Engine.
|
Package autocascade executes the side effects of automation results produced by automation.Engine. |
|
Package automation provides a trigger-action engine for entity lifecycle events.
|
Package automation provides a trigger-action engine for entity lifecycle events. |
|
Package cache provides small generic cache data structures.
|
Package cache provides small generic cache data structures. |
|
Package caldavalias maps CalDAV resources to rela entities.
|
Package caldavalias maps CalDAV resources to rela entities. |
|
Package calfeed models calendar feeds and serializes them to calendar interchange formats (iCalendar and JSON) as a service separate from the store.
|
Package calfeed models calendar feeds and serializes them to calendar interchange formats (iCalendar and JSON) as a service separate from the store. |
|
Package canonical produces a deterministic, backend-independent content hash for an entity.Entity or entity.Relation.
|
Package canonical produces a deterministic, backend-independent content hash for an entity.Entity or entity.Relation. |
|
Package cli wires the kong-based CLI.
|
Package cli wires the kong-based CLI. |
|
sync
Package sync implements the rela CLI sync client: a hash-indexed, topologically-ordered push/pull between a local fsstore project and a remote pgstore-backed rela-server's /api/sync/ API (FEAT-NJ9FEN, TKT-T4H4YK).
|
Package sync implements the rela CLI sync client: a hash-indexed, topologically-ordered push/pull between a local fsstore project and a remote pgstore-backed rela-server's /api/sync/ API (FEAT-NJ9FEN, TKT-T4H4YK). |
|
Package cmdexec runs external commands safely for the "bytes in → bytes out" pattern shared by attachment processing and view export.
|
Package cmdexec runs external commands safely for the "bytes in → bytes out" pattern shared by attachment processing and view export. |
|
Package comments holds user commentary attached to entities: a remark about a property or a view section, stored alongside the graph rather than in it.
|
Package comments holds user commentary attached to entities: a remark about a property or a view section, stored alongside the graph rather than in it. |
|
commentstest
Package commentstest is the conformance suite every comments.Store implementation must pass.
|
Package commentstest is the conformance suite every comments.Store implementation must pass. |
|
filecomments
Package filecomments stores comments as YAML, one file per target entity, under a directory the caller roots (conventionally `.rela/comments/`).
|
Package filecomments stores comments as YAML, one file per target entity, under a directory the caller roots (conventionally `.rela/comments/`). |
|
memcomments
Package memcomments is an in-memory comments.Store for tests and the memory build.
|
Package memcomments is an in-memory comments.Store for tests and the memory build. |
|
Package computed compiles and evaluates materialized entity-local computed properties.
|
Package computed compiles and evaluates materialized entity-local computed properties. |
|
Package conditionlint performs author-time validation of the condition expressions used by wizard forms (`visible_when` / `required_when`).
|
Package conditionlint performs author-time validation of the condition expressions used by wizard forms (`visible_when` / `required_when`). |
|
Package config provides read-only access to project-root configuration files — the YAML/JSON files users check into their repo alongside schema.yaml (data-entry.yaml, schedules.yaml, and so on).
|
Package config provides read-only access to project-root configuration files — the YAML/JSON files users check into their repo alongside schema.yaml (data-entry.yaml, schedules.yaml, and so on). |
|
configsql
Package configsql serves a project's operator-authored config — schema.yaml, data-entry.yaml, acl.yaml, scripts/, templates/, custom/ — from a SQL table rather than from files on disk.
|
Package configsql serves a project's operator-authored config — schema.yaml, data-entry.yaml, acl.yaml, scripts/, templates/, custom/ — from a SQL table rather than from files on disk. |
|
Package conflict provides detection and resolution of git merge conflicts in entity and relation markdown files.
|
Package conflict provides detection and resolution of git merge conflicts in entity and relation markdown files. |
|
Package dataentry provides a config-driven data entry web application built on top of rela's metamodel system.
|
Package dataentry provides a config-driven data entry web application built on top of rela's metamodel system. |
|
Package dataentryconfig contains the configuration types and validation logic for the data-entry web application.
|
Package dataentryconfig contains the configuration types and validation logic for the data-entry web application. |
|
icondefs
Package icondefs holds the canonical definition of the data-entry icon set: the one place a config-facing icon name, its Lucide component, its category and its description are written down.
|
Package icondefs holds the canonical definition of the data-entry icon set: the one place a config-facing icon name, its Lucide component, its category and its description are written down. |
|
Package datamigration migrates STORED CONTENT when the schema's data shape changes (TKT-0C57FS).
|
Package datamigration migrates STORED CONTENT when the schema's data shape changes (TKT-0C57FS). |
|
Package desktop provides desktop-specific functionality for the Wails desktop app, including user preferences persistence.
|
Package desktop provides desktop-specific functionality for the Wails desktop app, including user preferences persistence. |
|
Package docs implements the rela-docs "doc language": a Markdown file with embedded Lua "islands" that pull reference fragments from the schema and a seeded in-memory graph.
|
Package docs implements the rela-docs "doc language": a Markdown file with embedded Lua "islands" that pull reference fragments from the schema and a seeded in-memory graph. |
|
Package docscapture implements the browser-backed screenshot capture for the rela-docs screenshot{} island (Tier B).
|
Package docscapture implements the browser-backed screenshot capture for the rela-docs screenshot{} island (Tier B). |
|
Package docscli is the command layer for the standalone `rela-docs` binary: it resolves a Markdown manual's rela Lua islands (field tables, lifecycles, relation graphs, role matrices, and live `screenshot{}` captures) against a project's metamodel + acl.yaml.
|
Package docscli is the command layer for the standalone `rela-docs` binary: it resolves a Markdown manual's rela Lua islands (field tables, lifecycles, relation graphs, role matrices, and live `screenshot{}` captures) against a project's metamodel + acl.yaml. |
|
Package entity defines the domain types for rela entities and relations.
|
Package entity defines the domain types for rela entities and relations. |
|
Package entitymanager defines the entity-manager service — the "human intent" write path that runs automations, validation, and policy concerns (ACL, audit logging).
|
Package entitymanager defines the entity-manager service — the "human intent" write path that runs automations, validation, and policy concerns (ACL, audit logging). |
|
entitymanagertest
Package entitymanagertest provides test doubles for the entity-manager write path.
|
Package entitymanagertest provides test doubles for the entity-manager write path. |
|
Package frontmatter splits a YAML-frontmatter markdown document into its raw frontmatter block and body.
|
Package frontmatter splits a YAML-frontmatter markdown document into its raw frontmatter block and body. |
|
Package git provides git operations for the data entry app.
|
Package git provides git operations for the data entry app. |
|
Package htmlutil provides HTML post-processing utilities.
|
Package htmlutil provides HTML post-processing utilities. |
|
Package imgproc normalizes raster image bytes in-process, with no external tool and no OS sandbox.
|
Package imgproc normalizes raster image bytes in-process, with no external tool and no OS sandbox. |
|
Package importer provides functionality to import entities and relations from JSON, YAML, and CSV files into rela projects.
|
Package importer provides functionality to import entities and relations from JSON, YAML, and CSV files into rela projects. |
|
Package jobs is the background-job seam: one narrow interface every subsystem enqueues through, with durability tiered to the deployment model.
|
Package jobs is the background-job seam: one narrow interface every subsystem enqueues through, with durability tiered to the deployment model. |
|
jobstest
Package jobstest is the conformance harness for jobs.Queue implementations, in the same spirit as store/storetest and state/statetest.
|
Package jobstest is the conformance harness for jobs.Queue implementations, in the same spirit as store/storetest and state/statetest. |
|
Package jwtauth verifies signed identity assertions (ES256 JWTs) from an upstream OIDC identity proxy against its published JWKS.
|
Package jwtauth verifies signed identity assertions (ES256 JWTs) from an upstream OIDC identity proxy against its published JWKS. |
|
Lua bindings for the ai.* module (ai.chat, ai.complete, ai.embed).
|
Lua bindings for the ai.* module (ai.chat, ai.complete, ai.embed). |
|
Package mail sends outbound email.
|
Package mail sends outbound email. |
|
mailtest
Package mailtest provides a conformance suite for mail.Sender implementations, in the shape internal/store/storetest establishes: each implementation wires the suite through a Factory returning a fresh sender.
|
Package mailtest provides a conformance suite for mail.Sender implementations, in the shape internal/store/storetest establishes: each implementation wires the suite through a Factory returning a fresh sender. |
|
Package mailrender turns a message model into the two body parts an email carries: sanitized, CSS-inlined HTML and a plain-text alternative.
|
Package mailrender turns a message model into the two body parts an email carries: sanitized, CSS-inlined HTML and a plain-text alternative. |
|
Package mailtemplate builds recipient-scoped mail models from project declarations.
|
Package mailtemplate builds recipient-scoped mail models from project declarations. |
|
coverage-ignore: MCP prompt handlers - tested via integration tests
|
coverage-ignore: MCP prompt handlers - tested via integration tests |
|
Package mermaid renders mermaid diagram source from neutral, primitive inputs.
|
Package mermaid renders mermaid diagram source from neutral, primitive inputs. |
|
Package migration provides schema migration support for rela project files.
|
Package migration provides schema migration support for rela project files. |
|
Package natsort provides natural sorting for strings containing numbers.
|
Package natsort provides natural sorting for strings containing numbers. |
|
Package nextaction resolves ONE advisory suggestion from operator-declared sources.
|
Package nextaction resolves ONE advisory suggestion from operator-declared sources. |
|
Package openapi provides OpenAPI 3.1 spec generation from rela metamodels.
|
Package openapi provides OpenAPI 3.1 spec generation from rela metamodels. |
|
Package pattern provides glob pattern parsing, validation, and regex conversion.
|
Package pattern provides glob pattern parsing, validation, and regex conversion. |
|
Package perfseed generates a deterministic, realistically shaped entity graph for the perf demo project (prototypes/perf/project) and loads it into any store.Store.
|
Package perfseed generates a deterministic, realistically shaped entity graph for the perf demo project (prototypes/perf/project) and loads it into any store.Store. |
|
Package predicate is a small, sandboxed typed expression-evaluation engine over named values and host-registered functions.
|
Package predicate is a small, sandboxed typed expression-evaluation engine over named values and host-registered functions. |
|
Package predicatefns is the shared host-function standard library for the predicate engine.
|
Package predicatefns is the shared host-function standard library for the predicate engine. |
|
Package principal carries the identity attribution attached to each request: who initiated it (User) and through what entry point (Tool).
|
Package principal carries the identity attribution attached to each request: who initiated it (User) and through what entry point (Tool). |
|
Package propmatch is the single authoritative definition of what "empty" means for an entity property, plus the untyped string comparisons that can be decided without consulting the metamodel.
|
Package propmatch is the single authoritative definition of what "empty" means for an entity property, plus the untyped string comparisons that can be decided without consulting the metamodel. |
|
Package queryplan compiles the safe store-side subset of data-entry search queries.
|
Package queryplan compiles the safe store-side subset of data-entry search queries. |
|
Package renametype handles the entity-type rename operation (metamodel + directory + per-file YAML frontmatter + template).
|
Package renametype handles the entity-type rename operation (metamodel + directory + per-file YAML frontmatter + template). |
|
Package scheduler runs Lua scripts on simple recurring schedules.
|
Package scheduler runs Lua scripts on simple recurring schedules. |
|
Package schedulerstate holds per-task scheduling bookkeeping for github.com/Sourcehaven-BV/rela/internal/scheduler: when a task last ran successfully, how many times it has failed since, and when it may be tried again.
|
Package schedulerstate holds per-task scheduling bookkeeping for github.com/Sourcehaven-BV/rela/internal/scheduler: when a task last ran successfully, how many times it has failed since, and when it may be tried again. |
|
kvstate
Package kvstate is the schedulerstate.Store backend for the filesystem and desktop tiers, persisting through a state.KV.
|
Package kvstate is the schedulerstate.Store backend for the filesystem and desktop tiers, persisting through a state.KV. |
|
schedulerstatetest
Package schedulerstatetest is the shared contract every schedulerstate.Store implementation must satisfy.
|
Package schedulerstatetest is the shared contract every schedulerstate.Store implementation must satisfy. |
|
Package schema provides analysis and cleanup utilities for metamodel schemas.
|
Package schema provides analysis and cleanup utilities for metamodel schemas. |
|
Package script orchestrates script execution for automations and user- initiated script runs.
|
Package script orchestrates script execution for automations and user- initiated script runs. |
|
Package search provides full-text search over a store.Store, satisfied by a Backend (today: [bleveindex.Index]).
|
Package search provides full-text search over a store.Store, satisfied by a Backend (today: [bleveindex.Index]). |
|
bleveindex
Package bleveindex provides a bleve-backed implementation of search.Backend for full-text entity search.
|
Package bleveindex provides a bleve-backed implementation of search.Backend for full-text entity search. |
|
Package secrets loads per-script secret values from .rela/secrets.yaml.
|
Package secrets loads per-script secret values from .rela/secrets.yaml. |
|
Package sqlitedb owns the SQLite database FILE: opening it, verifying its PRAGMAs, holding the single-writer lock, and carrying its schema forward.
|
Package sqlitedb owns the SQLite database FILE: opening it, verifying its PRAGMAs, holding the single-writer lock, and carrying its schema forward. |
|
Package state provides a per-user key/value store for state that persists between runs but isn't part of the project's tracked source — UI state, render caches, scheduler bookkeeping.
|
Package state provides a per-user key/value store for state that persists between runs but isn't part of the project's tracked source — UI state, render caches, scheduler bookkeeping. |
|
statesql
Package statesql stores rela's runtime state — the document render cache, user settings, the operator's logo and theme, the CalDAV alias table — in a SQL table rather than in files under .rela/.
|
Package statesql stores rela's runtime state — the document render cache, user settings, the operator's logo and theme, the CalDAV alias table — in a SQL table rather than in files under .rela/. |
|
statetest
Package statetest is the conformance harness for state.KV implementations.
|
Package statetest is the conformance harness for state.KV implementations. |
|
Package statemachine compiles the declarative enum state machines in a metamodel (CustomType.Transitions, see TKT-E4LW2) into an executable form and enforces them on the entity write path.
|
Package statemachine compiles the declarative enum state machines in a metamodel (CustomType.Transitions, see TKT-E4LW2) into an executable form and enforces them on the entity write path. |
|
Package storage provides filesystem abstraction for rela's file I/O operations.
|
Package storage provides filesystem abstraction for rela's file I/O operations. |
|
Package store provides the storage abstraction for rela workspaces.
|
Package store provides the storage abstraction for rela workspaces. |
|
fsstore
Package fsstore provides a filesystem-backed implementation of store.Store.
|
Package fsstore provides a filesystem-backed implementation of store.Store. |
|
graphquerynaive
Package graphquerynaive ships the unoptimised, backend-agnostic implementation of store.GraphQueryer.
|
Package graphquerynaive ships the unoptimised, backend-agnostic implementation of store.GraphQueryer. |
|
memstore
Package memstore provides an in-memory implementation of store.Store.
|
Package memstore provides an in-memory implementation of store.Store. |
|
pgstore
Package pgstore provides a PostgreSQL implementation of store.Store.
|
Package pgstore provides a PostgreSQL implementation of store.Store. |
|
sqlitestore
Package sqlitestore implements store.Store on an embedded SQLite database.
|
Package sqlitestore implements store.Store on an embedded SQLite database. |
|
storetest
Package storetest provides a conformance test suite for store.Store implementations.
|
Package storetest provides a conformance test suite for store.Store implementations. |
|
storeutil
Package storeutil provides shared helpers for store.Store implementations.
|
Package storeutil provides shared helpers for store.Store implementations. |
|
Package sync holds backend-neutral value types shared by the sync feature (FEAT-NJ9FEN).
|
Package sync holds backend-neutral value types shared by the sync feature (FEAT-NJ9FEN). |
|
Package templating: fsloader.go contains the filesystem primitives used by FSTemplater to read, discover, and generate entity/relation template files.
|
Package templating: fsloader.go contains the filesystem primitives used by FSTemplater to read, discover, and generate entity/relation template files. |
|
Package tenant resolves a verified organization to the storage it — and only it — may reach.
|
Package tenant resolves a verified organization to the storage it — and only it — may reach. |
|
Package tracer provides graph traversal operations (trace, path, orphan detection, cycle detection, clustering) as a service separate from the store.
|
Package tracer provides graph traversal operations (trace, path, orphan detection, cycle detection, clustering) as a service separate from the store. |
|
Package transform is the view-export engine: it converts markdown produced by a Renderer into an output format (PDF, DOCX, ...) by running a named, project-configured external command.
|
Package transform is the view-export engine: it converts markdown produced by a Renderer into an output format (PDF, DOCX, ...) by running a named, project-configured external command. |
|
Package userstate holds per-user, per-suggestion state for the next-action layer: snoozes, muted sources, and last-shown timestamps.
|
Package userstate holds per-user, per-suggestion state for the next-action layer: snoozes, muted sources, and last-shown timestamps. |
|
kvuserstate
Package kvuserstate is the durable userstate.Store backend, persisting next-action state through a state.KV.
|
Package kvuserstate is the durable userstate.Store backend, persisting next-action state through a state.KV. |
|
memuserstate
Package memuserstate is the in-memory userstate.Store backend.
|
Package memuserstate is the in-memory userstate.Store backend. |
|
userstatetest
Package userstatetest is the conformance harness every userstate.Store implementation must pass.
|
Package userstatetest is the conformance harness every userstate.Store implementation must pass. |
|
Package validation provides custom validation rule checking for entities.
|
Package validation provides custom validation rule checking for entities. |
|
Package validator provides a Validator service that runs metamodel validation rules over a store.
|
Package validator provides a Validator service that runs metamodel validation rules over a store. |
|
Package visibility is the read-side ACL enforcement seam: wrappers that row-gate and field-redact entity reads ABOVE the (deliberately ungated) base services, per DEC-ZBI39P.
|
Package visibility is the read-side ACL enforcement seam: wrappers that row-gate and field-redact entity reads ABOVE the (deliberately ungated) base services, per DEC-ZBI39P. |
|
visibilitytest
Package visibilitytest is the conformance suite for the internal/visibility contracts (the analog of storetest's RunVisibleSearchTests): any visibility.Reader implementation and any visibility-decorated tracer.Tracer must pass it.
|
Package visibilitytest is the conformance suite for the internal/visibility contracts (the analog of storetest's RunVisibleSearchTests): any visibility.Reader implementation and any visibility-decorated tracer.Tracer must pass it. |
|
Package worldreader is the RUNTIME half of content-state worlds (TKT-WAV8XP Step 2): it resolves an entity to the single state a world selects — its "prime" — and hands out capabilities that carry that resolution so callers cannot accidentally read around it.
|
Package worldreader is the RUNTIME half of content-state worlds (TKT-WAV8XP Step 2): it resolves an entity to the single state a world selects — its "prime" — and hands out capabilities that carry that resolution so callers cannot accidentally read around it. |
|
Package worlds compiles the metamodel's `worlds:` declarations into store.WorldScope values — the metamodel-free, per-type ranked resolution the storage layer evaluates (TKT-WAV8XP, design doc §4).
|
Package worlds compiles the metamodel's `worlds:` declarations into store.WorldScope values — the metamodel-free, per-type ranked resolution the storage layer evaluates (TKT-WAV8XP, design doc §4). |
Click to show internal directories.
Click to hide internal directories.