Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gorun
command
Command gorun runs the GoRun CMS.
|
Command gorun runs the GoRun CMS. |
|
examples
|
|
|
extensions/hello-http
Package hello is a minimal GoRun extension speaking the HTTP bridge protocol (docs/EXTENSIONS.md).
|
Package hello is a minimal GoRun extension speaking the HTTP bridge protocol (docs/EXTENSIONS.md). |
|
extensions/hello-http/cmd/hello-http
command
Command hello-http runs the hello example extension:
|
Command hello-http runs the hello example extension: |
|
internal
|
|
|
admin
Package admin serves the core admin screens: dashboard widgets, users, roles, general and mail settings, system health and jobs, API keys, the audit viewer and the global admin search.
|
Package admin serves the core admin screens: dashboard widgets, users, roles, general and mail settings, system health and jobs, API keys, the audit viewer and the global admin search. |
|
api
Package api is the REST layer: it mounts every operation registered in kernel.APIRegistry under /api/v1 (with scope enforcement, panic recovery and a JSON default content type), serves the generated OpenAPI 3.1 document at /api/v1/openapi.json and the Scalar reference at /api/docs, and provides the core operations (/site, /me, /health) plus helpers (pagination, decoding, error envelopes) for other modules' handlers.
|
Package api is the REST layer: it mounts every operation registered in kernel.APIRegistry under /api/v1 (with scope enforcement, panic recovery and a JSON default content type), serves the generated OpenAPI 3.1 document at /api/v1/openapi.json and the Scalar reference at /api/docs, and provides the core operations (/site, /me, /health) plus helpers (pagination, decoding, error envelopes) for other modules' handlers. |
|
api/apitest
Package apitest boots GoRun for API tests and drives /api/v1 with a bearer API key.
|
Package apitest boots GoRun for API tests and drives /api/v1 with a bearer API key. |
|
audit
Package audit writes and reads the audit log.
|
Package audit writes and reads the audit log. |
|
auth
Package auth provides users, roles and permissions, sessions, CSRF, API keys, magic links, login rate limiting and the admin shell (login, setup, locale switch).
|
Package auth provides users, roles and permissions, sessions, CSRF, API keys, magic links, login rate limiting and the admin shell (login, setup, locale switch). |
|
backup
Package backup makes and lists data-directory backups: a consistent copy of the database (VACUUM INTO) and a tar.gz of data trees and local recovery configuration, both under <data>/backups/<UTC timestamp>.
|
Package backup makes and lists data-directory backups: a consistent copy of the database (VACUUM INTO) and a tar.gz of data trees and local recovery configuration, both under <data>/backups/<UTC timestamp>. |
|
commerce
Package commerce sells access to MCP servers: products → Stripe Checkout → orders → customers → entitlements → provisioning on billing servers over the signed mcp-billing/v1 protocol (spec §4.6, docs/COMMERCE.md).
|
Package commerce sells access to MCP servers: products → Stripe Checkout → orders → customers → entitlements → provisioning on billing servers over the signed mcp-billing/v1 protocol (spec §4.6, docs/COMMERCE.md). |
|
commerce/fakebilling
Package fakebilling is an in-memory billing server implementing the mcp-billing/v1 protocol (see docs/COMMERCE.md) for tests and local e2e runs: signature verification (same scheme as the real servers), Idempotency-Key replay on mutations, and failure injection.
|
Package fakebilling is an in-memory billing server implementing the mcp-billing/v1 protocol (see docs/COMMERCE.md) for tests and local e2e runs: signature verification (same scheme as the real servers), Idempotency-Key replay on mutations, and failure injection. |
|
config
Package config loads GoRun configuration.
|
Package config loads GoRun configuration. |
|
content
Package content manages content types, custom fields, content items, revisions and queries.
|
Package content manages content types, custom fields, content items, revisions and queries. |
|
db
Package db opens the GoRun SQLite database and provides migration, transaction, ID and time helpers shared by every module.
|
Package db opens the GoRun SQLite database and provides migration, transaction, ID and time helpers shared by every module. |
|
diagnostics
Package diagnostics stores bounded classifications, never raw log messages or attributes.
|
Package diagnostics stores bounded classifications, never raw log messages or attributes. |
|
edgeprovision
Package edgeprovision creates isolated GoRun Edge resources in an explicitly approved Cloudflare account.
|
Package edgeprovision creates isolated GoRun Edge resources in an explicitly approved Cloudflare account. |
|
ext
Package ext is the extension system (spec §4.9): extensions are external programs described by a manifest.
|
Package ext is the extension system (spec §4.9): extensions are external programs described by a manifest. |
|
hooks
Package hooks provides WordPress-style actions, filters and events.
|
Package hooks provides WordPress-style actions, filters and events. |
|
httpx
Package httpx holds shared HTTP plumbing: middleware, the API response envelope, form binding/validation, the SSRF-safe client and the admin template renderer.
|
Package httpx holds shared HTTP plumbing: middleware, the API response envelope, form binding/validation, the SSRF-safe client and the admin template renderer. |
|
i18n
Package i18n loads translation catalogs and resolves the request locale.
|
Package i18n loads translation catalogs and resolves the request locale. |
|
identityai
Package identityai is an optional module that asks a configured text AI connection for identity suggestions (palette, fonts, taglines, a logo brief) and writes them to the Appearance → Identity draft, never live.
|
Package identityai is an optional module that asks a configured text AI connection for identity suggestions (palette, fonts, taglines, a logo brief) and writes them to the Appearance → Identity draft, never live. |
|
identitylogo
Package identitylogo stages static PNG proposals privately.
|
Package identitylogo stages static PNG proposals privately. |
|
identitylogo/admin
Package identitylogoadmin exposes the optional static-logo workflow.
|
Package identitylogoadmin exposes the optional static-logo workflow. |
|
jobs
Package jobs is the DB-backed job queue: enqueue, workers with retry and exponential backoff, and a coarse cron scheduler.
|
Package jobs is the DB-backed job queue: enqueue, workers with retry and exponential backoff, and a coarse cron scheduler. |
|
kernel
Package kernel defines the Module contract and boots GoRun: it opens the database, runs each module's migrations, lets modules register into shared registries, and assembles the HTTP handler.
|
Package kernel defines the Module contract and boots GoRun: it opens the database, runs each module's migrations, lets modules register into shared registries, and assembles the HTTP handler. |
|
launch
Package launch serves the public /start journey (customer onboarding chrome) and relies on launch overlay assets embedded under web/launch.
|
Package launch serves the public /start journey (customer onboarding chrome) and relies on launch overlay assets embedded under web/launch. |
|
mailer
Package mailer sends transactional email over SMTP or Resend using mail.* settings.
|
Package mailer sends transactional email over SMTP or Resend using mail.* settings. |
|
mcp
Package mcp is GoRun's official Model Context Protocol server: the streamable HTTP endpoint at /mcp (bearer API keys only) and the stdio transport behind `gorun mcp --key`.
|
Package mcp is GoRun's official Model Context Protocol server: the streamable HTTP endpoint at /mcp (bearer API keys only) and the stdio transport behind `gorun mcp --key`. |
|
media
Package media manages the media library, storage drivers and image variants.
|
Package media manages the media library, storage drivers and image variants. |
|
membership
Package membership provides explicit local grants, never payment assertions.
|
Package membership provides explicit local grants, never payment assertions. |
|
menus
Package menus manages navigation menus and their items.
|
Package menus manages navigation menus and their items. |
|
metrics
Package metrics serves an optional Prometheus text exposition at GET /metrics.
|
Package metrics serves an optional Prometheus text exposition at GET /metrics. |
|
observe
Package observe keeps durable, revision-fenced observations of expensive or external checks so pages and APIs serve the last saved result at once while refreshes run as bounded background jobs.
|
Package observe keeps durable, revision-fenced observations of expensive or external checks so pages and APIs serve the last saved result at once while refreshes run as bounded background jobs. |
|
pattern
Package pattern is the site-layout pattern system: declarative packages that layer opinionated page templates above the active theme identity.
|
Package pattern is the site-layout pattern system: declarative packages that layer opinionated page templates above the active theme identity. |
|
redirects
Package redirects manages URL redirects.
|
Package redirects manages URL redirects. |
|
saas
Package saas preserves app ownership, subscriptions and atomic usage independently of commerce provisioning.
|
Package saas preserves app ownership, subscriptions and atomic usage independently of commerce provisioning. |
|
seo
Package seo renders SEO metadata, public sitemaps and robots.txt.
|
Package seo renders SEO metadata, public sitemaps and robots.txt. |
|
settings
Package settings is the key/value settings store.
|
Package settings is the key/value settings store. |
|
settings/settingsmod
Package settingsmod is the settings kernel.Module.
|
Package settingsmod is the settings kernel.Module. |
|
site
Package site is the public front controller: it maps public URLs to content, terms and listings and renders them through the active theme (theme.Service).
|
Package site is the public front controller: it maps public URLs to content, terms and listings and renders them through the active theme (theme.Service). |
|
starter
Package starter holds the content a new site starts with (Arabic sample posts, pages and categories as WXR), so a fresh site is never empty.
|
Package starter holds the content a new site starts with (Arabic sample posts, pages and categories as WXR), so a fresh site is never empty. |
|
taxonomy
Package taxonomy manages taxonomies, terms and their assignment to content.
|
Package taxonomy manages taxonomies, terms and their assignment to content. |
|
theme
Package theme loads themes, resolves the template hierarchy and renders the public site.
|
Package theme loads themes, resolves the template hierarchy and renders the public site. |
|
theme/fake
Package fake holds in-memory implementations of the services the theme engine and the site front controller consume (content, taxonomy, media, menus, redirects, seo), for tests.
|
Package fake holds in-memory implementations of the services the theme engine and the site front controller consume (content, taxonomy, media, menus, redirects, seo), for tests. |
|
update
Package update implements the staged core update lifecycle: a persisted operation whose phases (compatibility, release verification, backup, activation, health and links, final acceptance) are reported and completed independently, protected by a durable lease, driven by a resumable job, and reconciled after a process restart.
|
Package update implements the staged core update lifecycle: a persisted operation whose phases (compatibility, release verification, backup, activation, health and links, final acceptance) are reported and completed independently, protected by a durable lease, driven by a resumable job, and reconciled after a process restart. |
|
webhooks
Package webhooks sends signed HTTP notifications of site events (content, media, menus, forms, sign-ins, orders, migrations) to subscribed endpoints, with retries, a delivery log, redelivery and secret rotation.
|
Package webhooks sends signed HTTP notifications of site events (content, media, menus, forms, sign-ins, orders, migrations) to subscribed endpoints, with retries, a delivery log, redelivery and secret rotation. |
|
workagents
Package workagents runs owner-scoped text agents through GoRun's job queue.
|
Package workagents runs owner-scoped text agents through GoRun's job queue. |
|
wpmigrate
Package wpmigrate is the WordPress Migrator (spec §4.7): an honest Discovery Report, a 7-step wizard, a job-based import pipeline with resume/retry/dry-run, Gutenberg conversion, media download and URL rewrite, Yoast mapping, a WooCommerce catalog adapter and a WXR fallback.
|
Package wpmigrate is the WordPress Migrator (spec §4.7): an honest Discovery Report, a 7-step wizard, a job-based import pipeline with resume/retry/dry-run, Gutenberg conversion, media download and URL rewrite, Yoast mapping, a WooCommerce catalog adapter and a WXR fallback. |
|
wpmigrate/gutenberg
Package gutenberg parses WordPress block markup (<!-- wp:ns/name {json} --> … <!-- /wp:ns/name -->) into a tree and converts it to clean HTML for GoRun (spec §4.7).
|
Package gutenberg parses WordPress block markup (<!-- wp:ns/name {json} --> … <!-- /wp:ns/name -->) into a tree and converts it to clean HTML for GoRun (spec §4.7). |
|
wpmigrate/wxr
Package wxr parses WordPress eXtended RSS exports (Tools → Export), the fallback source when the REST API hides data (postmeta such as the MCBB product mapping, drafts, menus).
|
Package wxr parses WordPress eXtended RSS exports (Tools → Export), the fallback source when the REST API hides data (postmeta such as the MCBB product mapping, drafts, menus). |
|
pkg
|
|
|
cli
Package cli is the GoRun command line.
|
Package cli is the GoRun command line. |
|
edge
Package edge defines portable GoRun Edge site and manager authorization contracts.
|
Package edge defines portable GoRun Edge site and manager authorization contracts. |
|
patternkit
Package patternkit validates declarative site-layout pattern packages.
|
Package patternkit validates declarative site-layout pattern packages. |
|
themekit
Package themekit is the shared catalog theme contract: validation helpers for ship-with and custom themes.
|
Package themekit is the shared catalog theme contract: validation helpers for ship-with and custom themes. |
|
Package themes bundles the default theme for standalone local starts.
|
Package themes bundles the default theme for standalone local starts. |
|
tools
|
|
|
loadtest
command
Command loadtest runs a practical HTTP load harness against a local GoRun SQLite instance (or an existing base URL).
|
Command loadtest runs a practical HTTP load harness against a local GoRun SQLite instance (or an existing base URL). |
|
wp-record
command
Command wp-record records a WordPress site's public REST responses into a directory for local migration rehearsals (spec §7 "recorded fixture server").
|
Command wp-record records a WordPress site's public REST responses into a directory for local migration rehearsals (spec §7 "recorded fixture server"). |
|
Package web embeds the admin templates and static assets.
|
Package web embeds the admin templates and static assets. |
Click to show internal directories.
Click to hide internal directories.





















