Directories
¶
| Path | Synopsis |
|---|---|
|
Package applog wires the process-wide slog handler that fan-outs to stderr and a rolling text log under ~/.locorum/logs/locorum.log.
|
Package applog wires the process-wide slog handler that fan-outs to stderr and a rolling text log under ~/.locorum/logs/locorum.log. |
|
Package assets reconciles bundled (embedded) configuration files against the user's on-disk copy at ~/.locorum/config/.
|
Package assets reconciles bundled (embedded) configuration files against the user's on-disk copy at ~/.locorum/config/. |
|
Package cli implements Locorum's command-line surface.
|
Package cli implements Locorum's command-line surface. |
|
Package config is a typed facade over Locorum's flat key/value `settings` table.
|
Package config is a typed facade over Locorum's flat key/value `settings` table. |
|
Package daemon owns the process-coordination machinery for Locorum: the owner.lock that arbitrates which process owns Docker lifecycle, the local IPC transport (Unix domain socket on POSIX, named pipe on Windows), the JSON-RPC server bound to a SiteManager, and the matching client that CLI / MCP processes shell over.
|
Package daemon owns the process-coordination machinery for Locorum: the owner.lock that arbitrates which process owns Docker lifecycle, the local IPC transport (Unix domain socket on POSIX, named pipe on Windows), the JSON-RPC server bound to a SiteManager, and the matching client that CLI / MCP processes shell over. |
|
Package dbengine is the per-engine plug-in surface for Locorum's database story.
|
Package dbengine is the per-engine plug-in surface for Locorum's database story. |
|
fake
Package fake provides an in-memory dbengine.Execer for tests so they can exercise Snapshot / Restore / marker-write code paths without a running Docker daemon.
|
Package fake provides an in-memory dbengine.Execer for tests so they can exercise Snapshot / Restore / marker-write code paths without a running Docker daemon. |
|
fake
Package fake provides an in-memory docker.Engine for unit tests.
|
Package fake provides an in-memory docker.Engine for unit tests. |
|
Package genmark encodes the convention that Locorum-managed files carry a signature so the user can opt out of further regeneration by removing the line.
|
Package genmark encodes the convention that Locorum-managed files carry a signature so the user can opt out of further regeneration by removing the line. |
|
Package git wraps the user's installed git CLI for the small set of operations Locorum needs: cloning a remote, fetching, listing branches, creating and removing worktrees, and detecting dirty state.
|
Package git wraps the user's installed git CLI for the small set of operations Locorum needs: cloning a remote, fetching, listing branches, creating and removing worktrees, and detecting dirty state. |
|
Package health is Locorum's system-health surface.
|
Package health is Locorum's system-health surface. |
|
Package hooks lets users attach commands to the lifecycle events of a Locorum site (start, stop, delete, clone, version-change, multisite, export).
|
Package hooks lets users attach commands to the lifecycle events of a Locorum site (start, stop, delete, clone, version-change, multisite, export). |
|
fake
Package fake provides in-memory hooks.Runner / ContainerExecer / HostExecer implementations for tests in other packages.
|
Package fake provides in-memory hooks.Runner / ContainerExecer / HostExecer implementations for tests in other packages. |
|
Package integration holds real-Docker integration tests, all build- tagged `integration`.
|
Package integration holds real-Docker integration tests, all build- tagged `integration`. |
|
Package mcp implements a Model Context Protocol server that exposes Locorum's daemon as a curated set of tools to local AI agents.
|
Package mcp implements a Model Context Protocol server that exposes Locorum's daemon as a curated set of tools to local AI agents. |
|
Package orch is the small step-orchestrator at the heart of Locorum's site-lifecycle implementation.
|
Package orch is the small step-orchestrator at the heart of Locorum's site-lifecycle implementation. |
|
Package platform identifies the host Locorum is running on.
|
Package platform identifies the host Locorum is running on. |
|
Package router defines the contract for the global routing layer that terminates TLS, performs hostname-based routing, and forwards traffic to per-site web containers and global services (mail, adminer).
|
Package router defines the contract for the global routing layer that terminates TLS, performs hostname-based routing, and forwards traffic to per-site web containers and global services (mail, adminer). |
|
fake
Package fake is an in-memory Router used by tests that want to verify SiteManager wiring without spinning up Docker or Traefik.
|
Package fake is an in-memory Router used by tests that want to verify SiteManager wiring without spinning up Docker or Traefik. |
|
traefik
Package traefik implements router.Router using a single Traefik v3 container backed by Traefik's file provider.
|
Package traefik implements router.Router using a single Traefik v3 container backed by Traefik's file provider. |
|
Package secrets provides a process-wide secret registry used to redact known-sensitive substrings (DB passwords, auth tokens, salts) from any string that is about to be persisted, logged, or returned to a user- facing surface.
|
Package secrets provides a process-wide secret registry used to redact known-sensitive substrings (DB passwords, auth tokens, salts) from any string that is about to be persisted, logged, or returned to a user- facing surface. |
|
configyaml
Package configyaml projects a site's row + hooks onto a portable YAML file at <slug>/.locorum/config.yaml.
|
Package configyaml projects a site's row + hooks onto a portable YAML file at <slug>/.locorum/config.yaml. |
|
sitesteps
Package sitesteps assembles the per-site lifecycle Plan from individual orch.Step implementations.
|
Package sitesteps assembles the per-site lifecycle Plan from individual orch.Step implementations. |
|
Package testutil holds shared test fixtures and helpers.
|
Package testutil holds shared test fixtures and helpers. |
|
Package tls handles certificate lifecycle for the global routing layer.
|
Package tls handles certificate lifecycle for the global routing layer. |
|
fake
Package fake is an in-memory tls.Provider for unit tests.
|
Package fake is an in-memory tls.Provider for unit tests. |
|
Package updatecheck queries GitHub Releases for newer versions of Locorum and persists the answer between launches.
|
Package updatecheck queries GitHub Releases for newer versions of Locorum and persists the answer between launches. |
|
Package version exposes build-time identity for the Locorum binary.
|
Package version exposes build-time identity for the Locorum binary. |
|
Package wpcli ensures the pinned wp-cli phar (see internal/version for the version + SHA-512 pin) is present at ~/.locorum/bin/wp so every PHP container can bind-mount it as /usr/local/bin/wp.
|
Package wpcli ensures the pinned wp-cli phar (see internal/version for the version + SHA-512 pin) is present at ~/.locorum/bin/wp so every PHP container can bind-mount it as /usr/local/bin/wp. |
Click to show internal directories.
Click to hide internal directories.