Directories
¶
| Path | Synopsis |
|---|---|
|
Package buildinfo exposes the forge binary's version metadata to packages that cannot depend on internal/cli (to avoid import cycles).
|
Package buildinfo exposes the forge binary's version metadata to packages that cannot depend on internal/cli (to avoid import cycles). |
|
Package buildtarget owns the per-service build dispatch for services whose source lives outside the project's Go module — sibling repos, third-party binaries, language runtimes forge doesn't natively build.
|
Package buildtarget owns the per-service build dispatch for services whose source lives outside the project's Go module — sibling repos, third-party binaries, language runtimes forge doesn't natively build. |
|
Package checksums owns forge's file-ownership machinery: which bytes does forge certify as its own render, which files has the user taken over, and what may a generate run overwrite.
|
Package checksums owns forge's file-ownership machinery: which bytes does forge certify as its own render, which files has the user taken over, and what may a generate run overwrite. |
|
`forge generate accept-fork <path>...` — DEPRECATED alias for `forge disown`.
|
`forge generate accept-fork <path>...` — DEPRECATED alias for `forge disown`. |
|
add
Package add holds the `forge add` command group — the verbs that scaffold a new component (service / worker / operator / binary / frontend / webhook / package / adapter / library / handler-file / rpc / entity / crd / scenario) into an existing forge project.
|
Package add holds the `forge add` command group — the verbs that scaffold a new component (service / worker / operator / binary / frontend / webhook / package / adapter / library / handler-file / rpc / entity / crd / scenario) into an existing forge project. |
|
audit
Package audit holds the `forge audit` command group — a comprehensive snapshot of project state designed to orient an LLM (or human) without forcing them to grep ten different directories.
|
Package audit holds the `forge audit` command group — a comprehensive snapshot of project state designed to orient an LLM (or human) without forcing them to grep ten different directories. |
|
audittype
Package audittype holds the small, neutral value types shared by the `forge audit` command group (internal/cli/audit) and the internal/cli code that contributes audit categories it cannot compute without package-cli internals (the KCL-entity-typed ingress / external-builds categories, and friction.go's auditFriction).
|
Package audittype holds the small, neutral value types shared by the `forge audit` command group (internal/cli/audit) and the internal/cli code that contributes audit categories it cannot compute without package-cli internals (the KCL-entity-typed ingress / external-builds categories, and friction.go's auditFriction). |
|
backlog
Package backlog holds the `forge backlog` command group — list / add / close / open / migrate over the structured FORGE_BACKLOG.md.
|
Package backlog holds the `forge backlog` command group — list / add / close / open / migrate over the structured FORGE_BACKLOG.md. |
|
cmdutil
Package cmdutil holds cross-cutting helpers shared by forge's own CLI across MORE THAN ONE command group (internal/cli and its dir-nested subpackages).
|
Package cmdutil holds cross-cutting helpers shared by forge's own CLI across MORE THAN ONE command group (internal/cli and its dir-nested subpackages). |
|
component
Package component holds the `forge component` command group — list, search, and install UI components from forge's built-in component library.
|
Package component holds the `forge component` command group — list, search, and install UI components from forge's built-in component library. |
|
debug
Package debug holds the `forge debug` command group — a Delve-backed interactive debugger driver (start / break / continue / eval / ...).
|
Package debug holds the `forge debug` command group — a Delve-backed interactive debugger driver (start / break / continue / eval / ...). |
|
factory
Package factory carries the shared dependency set ("the factory") threaded through forge's own CLI command tree, plus the command REGISTRY that lets dir-nested command-group subpackages (internal/cli/add, internal/cli/lint, ...) attach to the root without a group↔root import cycle.
|
Package factory carries the shared dependency set ("the factory") threaded through forge's own CLI command tree, plus the command REGISTRY that lets dir-nested command-group subpackages (internal/cli/add, internal/cli/lint, ...) attach to the root without a group↔root import cycle. |
|
lint
Package lint holds the `forge lint` command group — the project linter pipeline (golangci / buf / frontend / forge-convention / scaffold / migration-safety / wire-coverage / authz-completeness …) plus the targeted single-rule flags and the --json aggregator.
|
Package lint holds the `forge lint` command group — the project linter pipeline (golangci / buf / frontend / forge-convention / scaffold / migration-safety / wire-coverage / authz-completeness …) plus the targeted single-rule flags and the --json aggregator. |
|
pack
Package pack holds the `forge pack` command group — manage installable packs (list / install / remove / info).
|
Package pack holds the `forge pack` command group — manage installable packs (list / install / remove / info). |
|
Package cliutil holds small helpers shared across forge's CLI surface.
|
Package cliutil holds small helpers shared across forge's CLI surface. |
|
Package cluster owns the render-KCL → kubectl-apply → wait-rollouts pipeline that `forge deploy`, `forge cluster reload`, and the deploy phase of `forge up` all execute.
|
Package cluster owns the render-KCL → kubectl-apply → wait-rollouts pipeline that `forge deploy`, `forge cluster reload`, and the deploy phase of `forge up` all execute. |
|
Package codegen renders Go source files for the canonical scaffolds forge produces: handler stubs, CRUD handlers, authorizer, auth/tenant middleware, bootstrap wiring, mock services, and config loaders.
|
Package codegen renders Go source files for the canonical scaffolds forge produces: handler stubs, CRUD handlers, authorizer, auth/tenant middleware, bootstrap wiring, mock services, and config loaders. |
|
Package config defines the canonical forge.yaml types shared across forge.
|
Package config defines the canonical forge.yaml types shared across forge. |
|
Package contractcheck inspects a project's internal/ tree for contract-shape violations.
|
Package contractcheck inspects a project's internal/ tree for contract-shape violations. |
|
Code generated by forge.
|
Code generated by forge. |
|
Package debug wraps a Delve debugger so forge can drive a debugging session from the CLI / MCP layers.
|
Package debug wraps a Delve debugger so forge can drive a debugging session from the CLI / MCP layers. |
|
Package deploytarget owns the per-service deploy dispatch — the surface that maps a rendered KCL Service.deploy block to a concrete pipeline that ships the service somewhere.
|
Package deploytarget owns the per-service deploy dispatch — the surface that maps a rendered KCL Service.deploy block to a concrete pipeline that ships the service somewhere. |
|
Package docs renders project documentation (markdown / hugo) from the project config, proto descriptors, and contract.go interfaces.
|
Package docs renders project documentation (markdown / hugo) from the project config, proto descriptors, and contract.go interfaces. |
|
Package doctor runs health checks against a forge project's development stack: docker-compose services, app endpoints, the telemetry backends bundled in the lgtm container, and the Delve debugger when --debug is active.
|
Package doctor runs health checks against a forge project's development stack: docker-compose services, app endpoints, the telemetry backends bundled in the lgtm container, and the Delve debugger when --debug is active. |
|
Package envutil holds the small, shared environment-handling helpers the build, deploy, and host-launch paths all need: a minimal .env parser and two env-overlay merges whose precedence is encoded in the name.
|
Package envutil holds the small, shared environment-handling helpers the build, deploy, and host-launch paths all need: a minimal .env parser and two env-overlay merges whose precedence is encoded in the name. |
|
Package generator: checksums shim.
|
Package generator: checksums shim. |
|
contract
Package contract drives the four *_gen.go files (mock, middleware, tracing, metrics) emitted from a single hand-written contract.go.
|
Package contract drives the four *_gen.go files (mock, middleware, tracing, metrics) emitted from a single hand-written contract.go. |
|
Package hostlaunch composes exec.Cmds for host-mode services and frontends, plus the small env-file helpers both call sites need.
|
Package hostlaunch composes exec.Cmds for host-mode services and frontends, plus the small env-file helpers both call sites need. |
|
Package installkit holds the small set of genuinely-shared rendering primitives used by `internal/packs`.
|
Package installkit holds the small set of genuinely-shared rendering primitives used by `internal/packs`. |
|
Package kclplugin registers forge's in-process KCL plugin namespace (kcl_plugin.forge.*), letting KCL pull host-runtime values during evaluation instead of forge having to pre-enumerate and inject them.
|
Package kclplugin registers forge's in-process KCL plugin namespace (kcl_plugin.forge.*), letting KCL pull host-runtime values during evaluation instead of forge having to pre-enumerate and inject them. |
|
Package kclrender is the single seam through which forge evaluates KCL.
|
Package kclrender is the single seam through which forge evaluates KCL. |
|
linter
|
|
|
authzlint
Package authzlint is the generate-time completeness gate for forge's descriptor-driven authorization.
|
Package authzlint is the generate-time completeness gate for forge's descriptor-driven authorization. |
|
finding
Package finding is the single canonical home for the lint-finding vocabulary shared by every internal linter (forgeconv, scaffolds, migrationlint, frontendpacklint).
|
Package finding is the single canonical home for the lint-finding vocabulary shared by every internal linter (forgeconv, scaffolds, migrationlint, frontendpacklint). |
|
forgeconv
Package forgeconv implements lint rules that enforce forge codegen conventions on proto files.
|
Package forgeconv implements lint rules that enforce forge codegen conventions on proto files. |
|
frontendpacklint
Package frontendpacklint provides a soft-rule analyzer that flags frontend pack templates importing third-party UI libraries directly instead of wrapping the forge base component library.
|
Package frontendpacklint provides a soft-rule analyzer that flags frontend pack templates importing third-party UI libraries directly instead of wrapping the forge base component library. |
|
scaffolds
Package scaffolds — `forge lint --check-workarounds` rule.
|
Package scaffolds — `forge lint --check-workarounds` rule. |
|
Code generated by forge.
|
Code generated by forge. |
|
Package projectstore is the single read+mutate surface for a forge project's state.
|
Package projectstore is the single read+mutate surface for a forge project's state. |
|
Package schemadef projects a project's APPLIED database schema — db/migrations/*.up.sql executed in order against a REAL ephemeral postgres — into a typed model that code generation consumes.
|
Package schemadef projects a project's APPLIED database schema — db/migrations/*.up.sql executed in order against a REAL ephemeral postgres — into a typed model that code generation consumes. |
|
Package secrets resolves declared secret REFERENCES (which live in git: EnvVar.secret_ref / secret_key) to secret VALUES (which never live in git) for one environment.
|
Package secrets resolves declared secret REFERENCES (which live in git: EnvVar.secret_ref / secret_key) to secret VALUES (which never live in git) for one environment. |
|
Package statefile is the one place forge's JSON-record-under-.forge/state helpers live.
|
Package statefile is the one place forge's JSON-record-under-.forge/state helpers live. |
|
Package templates owns the embedded forge template tree and renders it into scaffolded code.
|
Package templates owns the embedded forge template tree and renders it into scaffolded code. |
Click to show internal directories.
Click to hide internal directories.