Documentation
¶
Overview ¶
Package neckbeard embeds the agent-facing plugin assets — the skill, its references, and the slash commands — so the CLI binary is a complete distribution channel on its own: `neckbeard skill install` places them where Codex, Cursor, and any SKILL.md-speaking tool discovers them. Claude Code users get the same files straight from this repository through the plugin marketplace: the repository root is the plugin.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Commands embed.FS
Commands holds every plugin slash command (commands/<name>.md).
View Source
var References embed.FS
View Source
var SkillMD []byte
Functions ¶
This section is empty.
Types ¶
This section is empty.
Directories
¶
| Path | Synopsis |
|---|---|
|
bellwether is the representative reference application for neckbeard's release matrix (DESIGN §12.3): one binary, three modes matching the workload contract — an HTTP service, a background worker, and a scheduled job — using PostgreSQL when configured and degrading honestly when not.
|
bellwether is the representative reference application for neckbeard's release matrix (DESIGN §12.3): one binary, three modes matching the workload contract — an HTTP service, a background worker, and a scheduled job — using PostgreSQL when configured and degrading honestly when not. |
|
Package catalogassets distributes the tested catalog with the CLI binary.
|
Package catalogassets distributes the tested catalog with the CLI binary. |
|
cmd
|
|
|
neckbeard
command
neckbeard core CLI.
|
neckbeard core CLI. |
|
core
|
|
|
analyze
Package analyze is the deterministic detection layer under the analyzer (DESIGN §7, §8): it walks a repository and reports what is mechanically observable — Dockerfiles, exposed ports, environment-variable reads, language markers — as FACTS with file:line evidence, plus the inferences and assumptions those facts support.
|
Package analyze is the deterministic detection layer under the analyzer (DESIGN §7, §8): it walks a repository and reports what is mechanically observable — Dockerfiles, exposed ports, environment-variable reads, language markers — as FACTS with file:line evidence, plus the inferences and assumptions those facts support. |
|
blueprint
Package blueprint defines the generated lockfile: a pure, deterministic function of profile + config + manifest + catalog (DESIGN §9).
|
Package blueprint defines the generated lockfile: a pure, deterministic function of profile + config + manifest + catalog (DESIGN §9). |
|
catalog
Package catalog loads the module catalog index: the golden path, pinned.
|
Package catalog loads the module catalog index: the golden path, pinned. |
|
config
Package config loads and validates neckbeard.yaml, the user-owned configuration.
|
Package config loads and validates neckbeard.yaml, the user-owned configuration. |
|
doctor
Package doctor checks local prerequisites without contacting cloud accounts.
|
Package doctor checks local prerequisites without contacting cloud accounts. |
|
estimate
Package estimate implements the FinOps pipeline (DESIGN §13): the blueprint is rendered to a scratch directory (never the user's repo) and priced with Infracost's HCL parsing — no cloud credentials involved.
|
Package estimate implements the FinOps pipeline (DESIGN §13): the blueprint is rendered to a scratch directory (never the user's repo) and priced with Infracost's HCL parsing — no cloud credentials involved. |
|
ownership
Package ownership implements the file-ownership zones and regeneration contract (DESIGN §6.1–6.2): every generated file is tracked in .neckbeard/manifest.json with its content hash; regeneration replaces a file only when it is unmodified.
|
Package ownership implements the file-ownership zones and regeneration contract (DESIGN §6.1–6.2): every generated file is tracked in .neckbeard/manifest.json with its content hash; regeneration replaces a file only when it is unmodified. |
|
pipeline
Package pipeline holds the shared delivery model (DESIGN §11.1): one small internal description of the behaviors we generate — test, build/scan/push, per-env infra plan/apply with OIDC and environment binding — rendered to GitHub Actions and GitLab CI by deterministic renderers so the two can never drift.
|
Package pipeline holds the shared delivery model (DESIGN §11.1): one small internal description of the behaviors we generate — test, build/scan/push, per-env infra plan/apply with OIDC and environment binding — rendered to GitHub Actions and GitLab CI by deterministic renderers so the two can never drift. |
|
planner
Package planner resolves app profile + configuration + tier presets against the pinned catalog into a deterministic blueprint.
|
Package planner resolves app profile + configuration + tier presets against the pinned catalog into a deterministic blueprint. |
|
presets
Package presets embeds the tier presets: explicit dimensions and the module inputs / usage numbers each tier expands to (DESIGN §4.2).
|
Package presets embeds the tier presets: explicit dimensions and the module inputs / usage numbers each tier expands to (DESIGN §4.2). |
|
profile
Package profile loads app-profile.yaml — the agent-written, user-reviewed application profile.
|
Package profile loads app-profile.yaml — the agent-written, user-reviewed application profile. |
|
release
Package release prepares deployment foundations and deploys immutable images using native cloud CLIs.
|
Package release prepares deployment foundations and deploys immutable images using native cloud CLIs. |
|
render
Package render turns a blueprint into a write-set: a pure function of the blueprint, byte-identical on every call (DESIGN §9).
|
Package render turns a blueprint into a write-set: a pure function of the blueprint, byte-identical on every call (DESIGN §9). |
|
skillinstall
Package skillinstall places the neckbeard skill where coding agents discover it.
|
Package skillinstall places the neckbeard skill where coding agents discover it. |
|
validate
Package validate implements the V0 static level of the validation ladder (DESIGN §12.1).
|
Package validate implements the V0 static level of the validation ladder (DESIGN §12.1). |
|
version
Package version pins the planner/CLI version recorded in every blueprint.
|
Package version pins the planner/CLI version recorded in every blueprint. |
|
Package schemas embeds the language-neutral JSON Schema contracts and validates YAML documents against them.
|
Package schemas embeds the language-neutral JSON Schema contracts and validates YAML documents against them. |
Click to show internal directories.
Click to hide internal directories.