Directories
¶
| Path | Synopsis |
|---|---|
|
Package activation owns observation and atomic replacement of a target's current realization indirection plus conservative journal recovery.
|
Package activation owns observation and atomic replacement of a target's current realization indirection plus conservative journal recovery. |
|
Package activationwindow parses and evaluates the portable v1 target activation-window expression.
|
Package activationwindow parses and evaluates the portable v1 target activation-window expression. |
|
Package app implements the FXVCS use cases behind the public SDK.
|
Package app implements the FXVCS use cases behind the public SDK. |
|
Package cache is the host-wide, immutable, content-addressed object cache.
|
Package cache is the host-wide, immutable, content-addressed object cache. |
|
Package canonical implements the deterministic JSON encoding used for every FXVCS content identity: object manifests, asset indexes, the semantic release digest, and realization identity.
|
Package canonical implements the deterministic JSON encoding used for every FXVCS content identity: object manifests, asset indexes, the semantic release digest, and realization identity. |
|
Package chunk implements the versioned content-defined chunking (CDC) that FXVCS uses to store large assets as reusable pieces.
|
Package chunk implements the versioned content-defined chunking (CDC) that FXVCS uses to store large assets as reusable pieces. |
|
measure
Package measure is the Stage 2 chunking measurement spike (build plan §9, Stage 2): it compares whole-blob, fixed-size, and content-defined chunking over *version pairs* of representative assets and reports the numbers the go/no-go decision needs — transfer savings, stored bytes, CPU time, memory, and manifest overhead.
|
Package measure is the Stage 2 chunking measurement spike (build plan §9, Stage 2): it compares whole-blob, fixed-size, and content-defined chunking over *version pairs* of representative assets and reports the numbers the go/no-go decision needs — transfer savings, stored bytes, CPU time, memory, and manifest overhead. |
|
Package cli builds the fxvcs command tree.
|
Package cli builds the fxvcs command tree. |
|
drivers
Package drivers registers the Git process-boundary entry points (filter-process, diff-driver, merge-driver) and spike commands with the CLI.
|
Package drivers registers the Git process-boundary entry points (filter-process, diff-driver, merge-driver) and spike commands with the CLI. |
|
ui
Package ui is the presentation layer of the fxvcs CLI: headers, footers, aligned tables, item rows with a state word (and an optional symbol on a terminal), hints, byte formatting, and plural helpers.
|
Package ui is the presentation layer of the fxvcs CLI: headers, footers, aligned tables, item rows with a state word (and an optional symbol on a terminal), hints, byte formatting, and plural helpers. |
|
ui/live
Package live is the interactive progress view: a bounded, in-place display of an operation that touches many files.
|
Package live is the interactive progress view: a bounded, in-place display of an operation that touches many files. |
|
Package controlplane defines the backend-neutral coordination seam.
|
Package controlplane defines the backend-neutral coordination seam. |
|
gitops
Package gitops implements the coordination control plane over an ordinary Git repository (ADR 0004).
|
Package gitops implements the coordination control plane over an ordinary Git repository (ADR 0004). |
|
Package credentials stores the object-store secrets `fxvcs storage login` records, outside the repository and outside Git's administrative directories.
|
Package credentials stores the object-store secrets `fxvcs storage login` records, outside the repository and outside Git's administrative directories. |
|
Package deployment persists health-state transitions and last-known-good evidence around the pure health machine.
|
Package deployment persists health-state transitions and last-known-good evidence around the pure health machine. |
|
Package domain defines the Go representation of every FXVCS persisted format.
|
Package domain defines the Go representation of every FXVCS persisted format. |
|
Package durablefs contains platform-specific filesystem durability primitives shared by fxvcs' atomic writers.
|
Package durablefs contains platform-specific filesystem durability primitives shared by fxvcs' atomic writers. |
|
Package fileprotect applies the platform confidentiality boundary to files whose bytes contain resolved secret material.
|
Package fileprotect applies the platform confidentiality boundary to files whose bytes contain resolved secret material. |
|
Package filter implements the Git process boundary of FXVCS: the long-running clean/smudge filter (Git filter protocol version 2), the pointer-aware diff and merge drivers, the pre-push publication barrier, and launcher installation into repository-local Git config.
|
Package filter implements the Git process boundary of FXVCS: the long-running clean/smudge filter (Git filter protocol version 2), the pointer-aware diff and merge drivers, the pre-push publication barrier, and launcher installation into repository-local Git config. |
|
wire
Package wire connects the Git process boundary (internal/filter) to the engine (internal/app) so that the clean filter ingests through the same path as every SDK operation, smudge honours the hydration intent recorded in state.db, and the pre-push barrier consults the publication ledger.
|
Package wire connects the Git process boundary (internal/filter) to the engine (internal/app) so that the clean filter ingests through the same path as every SDK operation, smudge honours the hydration intent recorded in state.db, and the pre-push barrier consults the publication ledger. |
|
Package format owns FXVCS format-version negotiation: the committed document envelope (apiVersion/kind), semantic version comparison for minimumFXVCSVersion, pointer/object format identifiers, Git integration generations, and local SQLite schema versions.
|
Package format owns FXVCS format-version negotiation: the committed document envelope (apiVersion/kind), semantic version comparison for minimumFXVCSVersion, pointer/object format identifiers, Git integration generations, and local SQLite schema versions. |
|
Package gitclient is a small exec-based Git client used by the filter, diff/merge drivers, the pre-push hook, and setup/upgrade.
|
Package gitclient is a small exec-based Git client used by the filter, diff/merge drivers, the pre-push hook, and setup/upgrade. |
|
gittest
Package gittest creates throwaway Git repositories for tests.
|
Package gittest creates throwaway Git repositories for tests. |
|
Package health implements the deployment phase / retry-suppression state machine from docs/spec/health-and-rollback.md as a pure function so the contract can be fixture-tested without a running agent.
|
Package health implements the deployment phase / retry-suppression state machine from docs/spec/health-and-rollback.md as a pure function so the contract can be fixture-tested without a running agent. |
|
Package integrity computes FXVCS content identities from domain documents: object-manifest digests, asset roots, the semantic release digest, and sourceSetDigest.
|
Package integrity computes FXVCS content identities from domain documents: object-manifest digests, asset roots, the semantic release digest, and sourceSetDigest. |
|
Package journal defines the lock hierarchy every FXVCS mutation follows (docs/spec/checkout-consistency.md §3) and an in-process ordering guard.
|
Package journal defines the lock hierarchy every FXVCS mutation follows (docs/spec/checkout-consistency.md §3) and an in-process ordering guard. |
|
Package layout computes the normative target runtime layout (docs/spec/runtime-layout.md §1) and proves every path stays inside its root.
|
Package layout computes the normative target runtime layout (docs/spec/runtime-layout.md §1) and proves every path stays inside its root. |
|
Package lock provides the durable cross-process locks that serialize CLI, SDK consumers, the Git filter, and (later) the agent.
|
Package lock provides the durable cross-process locks that serialize CLI, SDK consumers, the Git filter, and (later) the agent. |
|
Package materialize owns the verified digest-keyed file store beneath a target deployment root and safe placement into out-of-place realizations.
|
Package materialize owns the verified digest-keyed file store beneath a target deployment root and safe placement into out-of-place realizations. |
|
Package migrate is the ordered migration model shared by every versioned FXVCS format that is upgraded in place (docs/spec/version-negotiation.md).
|
Package migrate is the ordered migration model shared by every versioned FXVCS format that is upgraded in place (docs/spec/version-negotiation.md). |
|
Package objectstore defines the immutable, content-addressed object store contract (build plan §6).
|
Package objectstore defines the immutable, content-addressed object store contract (build plan §6). |
|
filesystem
Package filesystem is the filesystem-backed object store: a directory tree (local disk, NFS/SMB share, or a synced folder) laid out as
|
Package filesystem is the filesystem-backed object store: a directory tree (local disk, NFS/SMB share, or a synced folder) laid out as |
|
s3
Package s3 is the S3-compatible object store backend (build plan §9, Stage 2).
|
Package s3 is the S3-compatible object store backend (build plan §9, Stage 2). |
|
Package pathsafe normalizes repository-relative paths and proves that a materialization destination stays inside its root.
|
Package pathsafe normalizes repository-relative paths and proves that a materialization destination stays inside its root. |
|
Package pointer encodes and decodes the FXVCS pointer stored in Git in place of a large asset.
|
Package pointer encodes and decodes the FXVCS pointer stored in Git in place of a large asset. |
|
profile
|
|
|
fivem
Package fivem is the FiveM profile: default tracking presets, the managed .gitattributes block, and change classification.
|
Package fivem is the FiveM profile: default tracking presets, the managed .gitattributes block, and change classification. |
|
fivem/catalog
Package catalog maintains the FiveM component resource catalog (.fxvcs/resources.yaml): synchronizing it with discovered manifests while preserving operator-owned fields, validating it for release, and diffing a pinned catalog against a rescan so release creation fails closed.
|
Package catalog maintains the FiveM component resource catalog (.fxvcs/resources.yaml): synchronizing it with discovered manifests while preserving operator-owned fields, validating it for release, and diffing a pinned catalog against a rescan so release creation fails closed. |
|
fivem/discovery
Package discovery finds FiveM resources inside a component tree using the FXServer scanning rules and the component's accepted descriptor, and proposes a descriptor for an unconfigured tree.
|
Package discovery finds FiveM resources inside a component tree using the FXServer scanning rules and the component's accepted descriptor, and proposes a descriptor for an unconfigured tree. |
|
fivem/manifest
Package manifest evaluates FiveM resource manifests (fxmanifest.lua and the legacy __resource.lua) inside a deterministic, capability-free Lua sandbox and returns the recorded metadata as plain data.
|
Package manifest evaluates FiveM resource manifests (fxmanifest.lua and the legacy __resource.lua) inside a deterministic, capability-free Lua sandbox and returns the recorded metadata as plain data. |
|
Package prune plans and applies exact target-local realization pruning.
|
Package prune plans and applies exact target-local realization pruning. |
|
Package rcon implements the FiveM UDP out-of-band RCON protocol exposed by the official citizen-server implementation.
|
Package rcon implements the FiveM UDP out-of-band RCON protocol exposed by the official citizen-server implementation. |
|
Package readiness runs independently bounded typed checks and evaluates startup grace, consecutive thresholds, and soak without owning deployment lifecycle transitions.
|
Package readiness runs independently bounded typed checks and evaluates startup grace, consecutive thresholds, and soak without owning deployment lifecycle transitions. |
|
Package reconcile contains the pure Stage 4 target reconciliation planner.
|
Package reconcile contains the pure Stage 4 target reconciliation planner. |
|
Package release builds immutable Release records from a pinned composition, compares two releases, and moves one release between coordination repositories as a portable document.
|
Package release builds immutable Release records from a pinned composition, compares two releases, and moves one release between coordination repositories as a portable document. |
|
Package repository locates and opens an FXVCS repository checkout and runs the mandatory open-preflight: envelope/version negotiation and the minimumFXVCSVersion / gitIntegrationVersion gate.
|
Package repository locates and opens an FXVCS repository checkout and runs the mandatory open-preflight: envelope/version negotiation and the minimumFXVCSVersion / gitIntegrationVersion gate. |
|
Package rollback constructs the safe realization input tuple for automatic rollback.
|
Package rollback constructs the safe realization input tuple for automatic rollback. |
|
Package runtimecheck validates Release runtime-resource requirements against an agent-bound installed system-resources inventory without claiming those target-provided bytes are Release-owned.
|
Package runtimecheck validates Release runtime-resource requirements against an agent-bound installed system-resources inventory without claiming those target-provided bytes are Release-owned. |
|
Package schema validates FXVCS documents against the embedded JSON Schemas (spec/schemas) and the semantic rules a schema cannot express, then decodes them into internal/domain types.
|
Package schema validates FXVCS documents against the embedded JSON Schemas (spec/schemas) and the semantic rules a schema cannot express, then decodes them into internal/domain types. |
|
Package secrets resolves Stage 4 host-local env and envfile providers while exposing only opaque keyed versions for realization identity and evidence.
|
Package secrets resolves Stage 4 host-local env and envfile providers while exposing only opaque keyed versions for realization identity and evidence. |
|
Package stack resolves a coordination composition: which component repositories participate, where each one mounts in the realization, which display name each one resolves to, and — with the runtime catalog and sparse overrides — the exact activation plan a Release snapshots.
|
Package stack resolves a coordination composition: which component repositories participate, where each one mounts in the realization, which display name each one resolves to, and — with the runtime catalog and sparse overrides — the exact activation plan a Release snapshots. |
|
Package state owns the clone-local and target-local SQLite databases (docs/spec/local-state.md and docs/stage-4-plan.md):
|
Package state owns the clone-local and target-local SQLite databases (docs/spec/local-state.md and docs/stage-4-plan.md): |
|
Package supervisor defines the capability boundary between reconciliation and target-provided process supervisors.
|
Package supervisor defines the capability boundary between reconciliation and target-provided process supervisors. |
|
Package templatehook implements the built-in, in-process template.v1 hook.
|
Package templatehook implements the built-in, in-process template.v1 hook. |
|
Package trust implements the deterministic parts of docs/spec/trust-and-signing.md that need no Git or key material: promotion tag naming and monotonic sequence selection, coordination authority policy validation, and the detached-signature envelope for canonical Release digests.
|
Package trust implements the deterministic parts of docs/spec/trust-and-signing.md that need no Git or key material: promotion tag naming and monotonic sequence selection, coordination authority policy validation, and the detached-signature envelope for canonical Release digests. |
|
Package verifier resolves portable external-resource contracts to explicit agent-local implementations.
|
Package verifier resolves portable external-resource contracts to explicit agent-local implementations. |
Click to show internal directories.
Click to hide internal directories.