Retracted: Versions before v0.1.3 predate the public release; use v0.1.3 or later.
Predate the public release; superseded by v0.1.3.
Documentation
¶
Overview ¶
Package onboard provides the embedded agent-onboarding script as a CLI-accessible asset. The canonical doc lives in this package (AGENT_ONBOARDING.md) and is embedded in the binary at build time; `vaultmind init --print-instructions` prints it on demand. Embedding rather than reading from disk means the doc travels with the binary — a new user with `go install`'d vaultmind can read the script without needing to clone the source repo.
Source-of-truth lives here, not under docs/, because Go's embed directive cannot traverse parent directories. README links to this path as the human-discoverable copy; the binary embeds the same file, so there is one source of truth (manifesto principle 7).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Instructions ¶
func Instructions() []byte
Instructions returns the embedded agent-onboarding doc as raw bytes. Returns the backing slice directly — callers must not mutate the returned bytes. A defensive copy would be wasteful for a 25KB doc; the only callers today are tests that immediately convert to string. Production callers should prefer PrintInstructions.
func PrintInstructions ¶
PrintInstructions writes the embedded onboarding doc verbatim to the supplied writer. Used by `vaultmind init --print-instructions` to route output to stdout (or a test buffer). Returns the writer's error if any; the embed itself cannot fail at runtime.
Types ¶
This section is empty.
Source Files