Documentation
¶
Overview ¶
Design: docs/architecture/core-design.md -- the development-tool composition root
Package le composes every development tool behind one registered root. A standalone cmd/ze binary named le and a tagged ze build call this same root.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Design: ai/rules/repo-maintenance.md -- one canonical source, several tool mirrors Related: actions.go -- the verbs that reach this mirror Related: report.go -- what a run answers
|
Design: ai/rules/repo-maintenance.md -- one canonical source, several tool mirrors Related: actions.go -- the verbs that reach this mirror Related: report.go -- what a run answers |
|
Design: docs/architecture/core-design.md -- the architecture lists, generated
|
Design: docs/architecture/core-design.md -- the architecture lists, generated |
|
Design: docs/architecture/testing/verify-freshness-scope.md -- what a scoped run covers Related: actions.go -- the verbs that reach this selection Related: scope.go -- the scoped-verify question this area also answers Related: report.go -- the two renderings of one selection
|
Design: docs/architecture/testing/verify-freshness-scope.md -- what a scoped run covers Related: actions.go -- the verbs that reach this selection Related: scope.go -- the scoped-verify question this area also answers Related: report.go -- the two renderings of one selection |
|
command
|
|
|
Design: docs/architecture/core-design.md -- one structured commit workflow command
|
Design: docs/architecture/core-design.md -- one structured commit workflow command |
|
config
|
|
|
Design: docs/architecture/testing/interop.md -- ze against a real peer Related: l2tp.go -- the first proof built on what this file holds Related: vppiface.go -- the second Related: daemonbuild.go -- the daemon both of them drive Related: gokrazykernel.go -- the kernel gate an appliance proof goes through Detail: netns.go -- the namespaces the on-host proofs keep their daemons apart in
|
Design: docs/architecture/testing/interop.md -- ze against a real peer Related: l2tp.go -- the first proof built on what this file holds Related: vppiface.go -- the second Related: daemonbuild.go -- the daemon both of them drive Related: gokrazykernel.go -- the kernel gate an appliance proof goes through Detail: netns.go -- the namespaces the on-host proofs keep their daemons apart in |
|
Design: docs/contributing/documentation-testing.md -- the digest anchor check
|
Design: docs/contributing/documentation-testing.md -- the digest anchor check |
|
Design: docs/architecture/core-design.md -- the generated package map Detail: report.go -- what the command answers and the two halves that write it Detail: sources.go -- which changed file can drift the index
|
Design: docs/architecture/core-design.md -- the generated package map Detail: report.go -- what the command answers and the two halves that write it Detail: sources.go -- which changed file can drift the index |
|
doc
|
|
|
wiring
Design: docs/architecture/core-design.md -- changed-file wiring and docs router.
|
Design: docs/architecture/core-design.md -- changed-file wiring and docs router. |
|
Package dockerhost names the Docker daemon socket a development command must talk to when nothing else can name one.
|
Package dockerhost names the Docker daemon socket a development command must talk to when nothing else can name one. |
|
Design: docs/architecture/core-design.md -- the generated docs-to-code index Detail: report.go -- what the command answers, and the rendering of the file Detail: codetodocs.go -- the MIRROR index, from the anchors inside docs/
|
Design: docs/architecture/core-design.md -- the generated docs-to-code index Detail: report.go -- what the command answers, and the rendering of the file Detail: codetodocs.go -- the MIRROR index, from the anchors inside docs/ |
|
Design: docs/architecture/core-design.md -- published command surfaces come from the live catalog
|
Design: docs/architecture/core-design.md -- published command surfaces come from the live catalog |
|
Design: docs/architecture/testing/ci-format.md -- the release-candidate gate Detail: report.go -- the payload this run answers Related: actions.go -- the area table that reaches this run
|
Design: docs/architecture/testing/ci-format.md -- the release-candidate gate Detail: report.go -- the payload this run answers Related: actions.go -- the area table that reaches this run |
|
Design: ai/rules/plugins.md -- static consumers are GENERATED, not hand-maintained Related: daemontags.go -- the second consumer of the same manifest
|
Design: ai/rules/plugins.md -- static consumers are GENERATED, not hand-maintained Related: daemontags.go -- the second consumer of the same manifest |
|
Design: docs/architecture/core-design.md -- how le runs a gate's command Detail: ../gotoolchain/gotoolchain.go -- the environment that command runs under
|
Design: docs/architecture/core-design.md -- how le runs a gate's command Detail: ../gotoolchain/gotoolchain.go -- the environment that command runs under |
|
Design: docs/architecture/core-design.md -- moving Go declarations between files
|
Design: docs/architecture/core-design.md -- moving Go declarations between files |
|
Design: docs/architecture/appliance/gokrazy-build-pins.md -- the packed go.sum gate
|
Design: docs/architecture/appliance/gokrazy-build-pins.md -- the packed go.sum gate |
|
Design: docs/architecture/core-design.md -- hook selftests and runtime are one le action area Overview: hookcheck.go -- native selftest implementation
|
Design: docs/architecture/core-design.md -- hook selftests and runtime are one le action area Overview: hookcheck.go -- native selftest implementation |
|
Design: docs/architecture/core-design.md -- native delegation hook policy
|
Design: docs/architecture/core-design.md -- native delegation hook policy |
|
Design: docs/architecture/resolve.md -- compiled RIR delegation seed
|
Design: docs/architecture/resolve.md -- compiled RIR delegation seed |
|
Design: docs/architecture/testing/interop.md -- what an integration gate needs Detail: actions.go -- the dispatch every row here is turned into
|
Design: docs/architecture/testing/interop.md -- what an integration gate needs Detail: actions.go -- the dispatch every row here is turned into |
|
Design: docs/architecture/testing/interop.md -- scenario discovery and selector contract Related: lab.go -- discovered scenarios become lifecycle plans.
|
Design: docs/architecture/testing/interop.md -- scenario discovery and selector contract Related: lab.go -- discovered scenarios become lifecycle plans. |
|
bgp
Design: docs/architecture/testing/interop.md -- fail-closed peer assertions.
|
Design: docs/architecture/testing/interop.md -- fail-closed peer assertions. |
|
ipsec
Design: docs/architecture/testing/interop.md -- complete typed assertions for every checked-in strongSwan scenario.
|
Design: docs/architecture/testing/interop.md -- complete typed assertions for every checked-in strongSwan scenario. |
|
l2tp
Design: plan/spec-le-is-a-ze-binary.md -- typed L2TP scenario assertions.
|
Design: plan/spec-le-is-a-ze-binary.md -- typed L2TP scenario assertions. |
|
l2tp/radiusmock
command
Design: docs/architecture/testing/interop.md -- independent RADIUS wire peer for the L2TP accounting scenario.
|
Design: docs/architecture/testing/interop.md -- independent RADIUS wire peer for the L2TP accounting scenario. |
|
pppoe
Design: docs/architecture/testing/interop.md -- typed Ze access-concentrator checks against an independent pppd client.
|
Design: docs/architecture/testing/interop.md -- typed Ze access-concentrator checks against an independent pppd client. |
|
Design: docs/architecture/core-design.md -- admission for heavy jobs in a shared checkout Detail: registry.go -- the entry that IS the claim, and the scan that reads every one of them Detail: attach.go -- what a second asker does instead of running the same job twice Detail: treehash.go -- the fingerprint of the tree a job judges Detail: jobkey.go -- the fingerprint of the work a job does
|
Design: docs/architecture/core-design.md -- admission for heavy jobs in a shared checkout Detail: registry.go -- the entry that IS the claim, and the scan that reads every one of them Detail: attach.go -- what a second asker does instead of running the same job twice Detail: treehash.go -- the fingerprint of the tree a job judges Detail: jobkey.go -- the fingerprint of the work a job does |
|
Design: docs/architecture/core-design.md -- the journal area, as one command
|
Design: docs/architecture/core-design.md -- the journal area, as one command |
|
Design: docs/architecture/core-design.md -- an le area, as one command
|
Design: docs/architecture/core-design.md -- an le area, as one command |
|
Design: docs/architecture/core-design.md -- le's checkout discovery
|
Design: docs/architecture/core-design.md -- le's checkout discovery |
|
Design: docs/architecture/core-design.md -- le's registration adapter Detail: dispatch.go -- the loop that runs the commands registered here Detail: group.go -- the five groups a registration names, and their order
|
Design: docs/architecture/core-design.md -- le's registration adapter Detail: dispatch.go -- the loop that runs the commands registered here Detail: group.go -- the five groups a registration names, and their order |
|
Design: plan/spec-le-is-a-ze-binary.md -- module migration workflows
|
Design: plan/spec-le-is-a-ze-binary.md -- module migration workflows |
|
Design: docs/architecture/core-design.md -- native developer-tool actions
|
Design: docs/architecture/core-design.md -- native developer-tool actions |
|
actions.go exposes the native netlab render check and golden rewrite through leaction.
|
actions.go exposes the native netlab render check and golden rewrite through leaction. |
|
Design: docs/architecture/core-design.md -- the perf benchmark, as three actions Detail: ../../test/perfrunner/run.go -- the multi-DUT Docker run these verbs drive Overview: actions.go -- the table these three verbs are declared in
|
Design: docs/architecture/core-design.md -- the perf benchmark, as three actions Detail: ../../test/perfrunner/run.go -- the multi-DUT Docker run these verbs drive Overview: actions.go -- the table these three verbs are declared in |
|
Design: docs/architecture/core-design.md -- the platform-vet area, as one command Overview: platformvet.go -- the shared runner for both cross-target actions
|
Design: docs/architecture/core-design.md -- the platform-vet area, as one command Overview: platformvet.go -- the shared runner for both cross-target actions |
|
plugin
|
|
|
imports
Design: docs/architecture/command-ownership.md -- the generated composition root
|
Design: docs/architecture/command-ownership.md -- the generated composition root |
|
Design: ai/rules/protocol.md -- the protocol skeleton, as a lens
|
Design: ai/rules/protocol.md -- the protocol skeleton, as a lens |
|
Design: docs/architecture/testing/qemu-integration.md -- what the VM proves Related: alltests_report.go -- what one whole run answers Related: actions.go -- the verb that reaches this run
|
Design: docs/architecture/testing/qemu-integration.md -- what the VM proves Related: alltests_report.go -- what one whole run answers Related: actions.go -- the verb that reaches this run |
|
Design: docs/architecture/core-design.md -- what the repository gate answers
|
Design: docs/architecture/core-design.md -- what the repository gate answers |
|
Design: docs/architecture/core-design.md -- the rfc area, as one command Overview: rfc.go -- the types, the paths and the closed sets every reader here shares
|
Design: docs/architecture/core-design.md -- the rfc area, as one command Overview: rfc.go -- the types, the paths and the closed sets every reader here shares |
|
Design: docs/architecture/core-design.md -- measure whether routed rules were read Overview: actions.go -- the rules command surface Related: rules.go -- the shared rule corpus predicate
|
Design: docs/architecture/core-design.md -- measure whether routed rules were read Overview: actions.go -- the rules command surface Related: rules.go -- the shared rule corpus predicate |
|
Design: docs/contributing/running-commands.md -- the lines of a run log a reader needs first Related: ../verify/engine/summary.go -- the verification failure index built from these lines Related: ../job/quiet.go -- the same lines, answered by one job
|
Design: docs/contributing/running-commands.md -- the lines of a run log a reader needs first Related: ../verify/engine/summary.go -- the verification failure index built from these lines Related: ../job/quiet.go -- the same lines, answered by one job |
|
Design: docs/architecture/core-design.md -- le action packages Overview: scratch.go -- filesystem policy and implementation
|
Design: docs/architecture/core-design.md -- le action packages Overview: scratch.go -- filesystem policy and implementation |
|
Design: docs/architecture/core-design.md -- native session lifecycle command Related: seed.go -- session store seeding Related: summary.go -- session recovery snapshot
|
Design: docs/architecture/core-design.md -- native session lifecycle command Related: seed.go -- session store seeding Related: summary.go -- session recovery snapshot |
|
Design: docs/guide/developer-setup.md -- the supported Ubuntu server bootstrap
|
Design: docs/guide/developer-setup.md -- the supported Ubuntu server bootstrap |
|
Design: website/AI.md -- one native command surface owns site build tools
|
Design: website/AI.md -- one native command surface owns site build tools |
|
facts
Design: docs/architecture/core-design.md -- the published repository facts, as one command
|
Design: docs/architecture/core-design.md -- the published repository facts, as one command |
|
wiki
Design: docs/architecture/core-design.md -- the wiki-index area, as one command
|
Design: docs/architecture/core-design.md -- the wiki-index area, as one command |
|
Design: docs/architecture/core-design.md -- one command area, separate native actions
|
Design: docs/architecture/core-design.md -- one command area, separate native actions |
|
spec
|
|
|
citation
Design: docs/architecture/core-design.md -- le's native development gates Related: report.go -- structured findings and the legacy text rendering
|
Design: docs/architecture/core-design.md -- le's native development gates Related: report.go -- structured findings and the legacy text rendering |
|
session
Package specsession owns spec claims, state paths, review artifacts, and the transcript facts those contracts use.
|
Package specsession owns spec claims, state paths, review artifacts, and the transcript facts those contracts use. |
|
status
Design: docs/architecture/core-design.md -- le's spec inventory
|
Design: docs/architecture/core-design.md -- le's spec inventory |
|
Design: docs/architecture/core-design.md -- the ste area Overview: ste.go -- the checker behind each action
|
Design: docs/architecture/core-design.md -- the ste area Overview: ste.go -- the checker behind each action |
|
Design: docs/architecture/core-design.md -- one definition of the demo manifest contract Overview: manifest.go -- the contracts a render writes and verifies Related: types.go -- Manifest, Demo and ArtifactEntry, which this answers
|
Design: docs/architecture/core-design.md -- one definition of the demo manifest contract Overview: manifest.go -- the contracts a render writes and verifies Related: types.go -- Manifest, Demo and ArtifactEntry, which this answers |
|
Design: docs/architecture/core-design.md -- the chaos test area.
|
Design: docs/architecture/core-design.md -- the chaos test area. |
|
Design: docs/architecture/testing/test-health.md -- native health actions
|
Design: docs/architecture/testing/test-health.md -- native health actions |
|
Design: docs/architecture/core-design.md -- native development command composition
|
Design: docs/architecture/core-design.md -- native development command composition |
|
Design: docs/architecture/core-design.md -- the unit-test area as one command Overview: groups.go -- the six package groups and their order
|
Design: docs/architecture/core-design.md -- the unit-test area as one command Overview: groups.go -- the six package groups and their order |
|
Design: docs/architecture/testing/test-health.md -- weakened-test gate declarations Related: testweakened.go -- the live check; selftest.go -- the fixture proof.
|
Design: docs/architecture/testing/test-health.md -- weakened-test gate declarations Related: testweakened.go -- the live check; selftest.go -- the fixture proof. |
|
Design: docs/architecture/core-design.md -- stable quoted diagnostic values.
|
Design: docs/architecture/core-design.md -- stable quoted diagnostic values. |
|
Design: ai/rules/architecture.md -- the tier area, as one command
|
Design: ai/rules/architecture.md -- the tier area, as one command |
|
Design: ai/rules/context-economy.md -- where a session's tokens go Detail: aggregate.go -- the figures derived from what this file reads Detail: run.go -- the command that resolves a store and fills the report
|
Design: ai/rules/context-economy.md -- where a session's tokens go Detail: aggregate.go -- the figures derived from what this file reads Detail: run.go -- the command that resolves a store and fills the report |
|
Design: docs/architecture/core-design.md -- the vendored-web tools, as commands
|
Design: docs/architecture/core-design.md -- the vendored-web tools, as commands |
|
Design: docs/architecture/testing/verify-freshness-scope.md -- detached-worktree verification command
|
Design: docs/architecture/testing/verify-freshness-scope.md -- detached-worktree verification command |
|
deps
Design: docs/architecture/core-design.md -- verifier dependencies as one command Overview: verifydeps.go -- plans, execution, and structured reports
|
Design: docs/architecture/core-design.md -- verifier dependencies as one command Overview: verifydeps.go -- plans, execution, and structured reports |
|
dispatch
Design: docs/architecture/core-design.md -- registered in-process verification dispatch
|
Design: docs/architecture/core-design.md -- registered in-process verification dispatch |
|
engine
Design: docs/functional-tests.md -- published verification failure protocol
|
Design: docs/functional-tests.md -- published verification failure protocol |
|
failuregroup
Design: docs/architecture/testing/verify-freshness-scope.md -- failure attribution Related: ../engine/artifacts.go -- declaredGroups, which reads what Declare writes Related: ../../commit/verification.go -- structuralGateReds, which charges the red
|
Design: docs/architecture/testing/verify-freshness-scope.md -- failure attribution Related: ../engine/artifacts.go -- declaredGroups, which reads what Declare writes Related: ../../commit/verification.go -- structuralGateReds, which charges the red |
|
lint
Design: docs/architecture/core-design.md -- native verifier work is callable through le Detail: verifylint.go -- the full lint plan and direct process execution
|
Design: docs/architecture/core-design.md -- native verifier work is callable through le Detail: verifylint.go -- the full lint plan and direct process execution |
|
lock
Design: docs/architecture/core-design.md -- verify-class admission through the shared job registry Related: ../job/job.go -- the single admission, locking, and process implementation
|
Design: docs/architecture/core-design.md -- verify-class admission through the shared job registry Related: ../job/job.go -- the single admission, locking, and process implementation |
|
status
Design: docs/architecture/testing/verify-freshness-scope.md -- verification status command
|
Design: docs/architecture/testing/verify-freshness-scope.md -- verification status command |
|
summary
Design: docs/architecture/testing/verify-freshness-scope.md -- verification failure summary command
|
Design: docs/architecture/testing/verify-freshness-scope.md -- verification failure summary command |
|
Design: docs/architecture/web-interface.md -- per-page web asset sets
|
Design: docs/architecture/web-interface.md -- per-page web asset sets |
|
Design: docs/architecture/core-design.md -- the weekly update's command Detail: poster.go -- what the parsed options drive
|
Design: docs/architecture/core-design.md -- the weekly update's command Detail: poster.go -- what the parsed options drive |
|
Design: docs/architecture/core-design.md -- one closed le action area
|
Design: docs/architecture/core-design.md -- one closed le action area |
|
Design: ai/rules/git-safety.md -- how wide the uncommitted tree is
|
Design: ai/rules/git-safety.md -- how wide the uncommitted tree is |
|
Design: ai/rules/git-safety.md -- what may rewrite a checkout, and what may not Related: report.go -- what an update answers Related: actions.go -- the verb that reaches this updater
|
Design: ai/rules/git-safety.md -- what may rewrite a checkout, and what may not Related: report.go -- what an update answers Related: actions.go -- the verb that reaches this updater |
|
yang
|
|
|
glue
Design: docs/architecture/command-ownership.md -- YANG as data, generated glue wires it in
|
Design: docs/architecture/command-ownership.md -- YANG as data, generated glue wires it in |
|
migration
Design: plan/spec-le-is-a-ze-binary.md -- three native YANG migration actions
|
Design: plan/spec-le-is-a-ze-binary.md -- three native YANG migration actions |
Click to show internal directories.
Click to hide internal directories.