Documentation previewThese docs are actively being built. Some pages may change as the framework and examples are finalized.
Skip to content

Generated Files

Generated files are not all owned the same way.

Check file headers and local package READMEs before editing.

Common Files and Directories

PathPurpose
.goforj.ymlProject render and development contract.
.envLocal runtime environment defaults.
cmd/app/main.goDefault app binary entrypoint.
cmd/<app>/main.goNamed app binary entrypoint.
cmd/<app>/frontend/Frontend source and embedded build output for an app with Web UI.
app/commands.goDefault app command exposure.
app/lifecycle.goDefault app lifecycle hooks.
app/routes.goDefault app route exposure.
app/schedules.goDefault app schedule exposure.
app/wire/wire.goDefault app Wire injector definitions.
app/wire/wire_gen.goGenerated Wire output. Do not edit by hand.
app/<app>/...Named app composition files.
app/<app>/wire/...Named app Wire graph.
internal/runtime/apps.goGenerated app metadata and deterministic runtime defaults. Do not edit by hand.
internal/caches/*_gen.goGenerated cache accessors and config when Cache is enabled.
internal/storages/*_gen.goGenerated storage accessors and config when File Storage is enabled.
internal/queues/*_gen.goGenerated queue accessors and config when Background Jobs is enabled.
internal/events/*_gen.goGenerated event bus accessors and config when Events is enabled.
internal/database/*_gen.goGenerated DB accessors and config when a database component is enabled.
build/api_index.jsonDefault app API index output.
build/api_index.diagnostics.jsonDefault app API index diagnostics.
build/openapi.jsonDefault app OpenAPI output.
build/.webindex-artifacts.lockPublication lock coordinating the default app artifact set.
build/<app>/api_index.jsonNamed app API index output.
build/<app>/api_index.diagnostics.jsonNamed app API index diagnostics.
build/<app>/openapi.jsonNamed app OpenAPI output.
build/<app>/.webindex-artifacts.lockPublication lock coordinating one named app artifact set.
.goforj/backups/<set>/manifest.jsonLocal backup set inventory.
.goforj/backups/<set>/checksums.txtChecksums for backup artifacts.

Ownership Rules

  • Files marked DO NOT EDIT should be regenerated.
  • Render-once files are App-owned extension points.
  • internal/ owns behavior; app/ owns exposure.
  • Framework-wide changes belong in GoForj templates or generators, not only in a rendered Project.
  • API artifacts and publication locks are tool-owned. Backup sets are operator-owned data and must not be committed.