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
- func Commands() []byte
- func FirstSteps(vault string) []string
- func IdentityFirstSteps(vault, profile string) []string
- func Instructions() []byte
- func MeshQuickStart() []byte
- func PrintFull(w io.Writer) error
- func PrintInstructions(w io.Writer) error
- func PrintMeshQuickStart(w io.Writer) error
- func PrintQuickStart(w io.Writer) error
- func QuickStart() []byte
Constants ¶
const AskQuestion = "what did we decide about retries?"
AskQuestion is the question the first ask runs, in the README and in init's next steps.
const InitFlagsLine = "" /* 131-byte string literal not displayed */
InitFlagsLine names the two init flags that sit beside the first steps.
const QuickstartVault = "./knowledge"
QuickstartVault is the vault path the README Quickstart types.
const ShellExpandSentence = "" /* 326-byte string literal not displayed */
ShellExpandSentence is why the quickstart passes *.md. The shell expands it, and dotfiles stay out.
Variables ¶
This section is empty.
Functions ¶
func Commands ¶ added in v0.1.11
func Commands() []byte
Commands returns the embedded grouped command reference (COMMANDS.md) as raw bytes. Same no-mutate contract as Instructions. Production callers should prefer PrintFull, which appends it to the onboarding guide.
func FirstSteps ¶ added in v0.10.17
FirstSteps are the commands a new vault's next steps and the README Quickstart both print, in order (Principle 7 — one list). vault is the path the operator types.
func IdentityFirstSteps ¶ added in v0.10.17
IdentityFirstSteps starts retrieval and installs hooks for an identity vault (persona or full profile), filled by editing its starter notes.
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 MeshQuickStart ¶ added in v0.2.0
func MeshQuickStart() []byte
MeshQuickStart returns the embedded mesh onboarding quick-start (MESH_QUICKSTART.md) as raw bytes. Same no-mutate contract as QuickStart: it is the "how the identity verbs fit together" narrative for joining a Contract-B agent network (admin + member journeys). Production callers should prefer PrintMeshQuickStart.
func PrintFull ¶ added in v0.1.11
PrintFull writes the full agent-onboarding guide followed by the generated grouped command reference, so `vaultmind init --print-instructions --full` hands an agent both the wiring narrative AND the complete catalog of commands (with when-to-use) in one paste. A blank line separates the two so the appended reference reads as its own section.
func PrintInstructions ¶
PrintInstructions writes the embedded onboarding doc verbatim to the supplied writer. Used by `vaultmind init --print-instructions --full` to route output to stdout (or a test buffer). Returns the writer's error if any; the embed itself cannot fail at runtime.
func PrintMeshQuickStart ¶ added in v0.2.0
PrintMeshQuickStart writes the embedded mesh onboarding quick-start verbatim to the supplied writer. Used by `vaultmind identity --print-instructions`. Returns the writer's error if any; the embed itself cannot fail at runtime.
func PrintQuickStart ¶ added in v0.1.10
PrintQuickStart writes the embedded quick-start verbatim to the supplied writer. Used by `vaultmind init --print-instructions` (the default — quick-start over the full guide). Returns the writer's error if any; the embed itself cannot fail at runtime.
func QuickStart ¶ added in v0.1.10
func QuickStart() []byte
QuickStart returns the embedded concise quick-start as raw bytes. Same no-mutate contract as Instructions: the quick-start is the skimmable 20% that gets an agent wired; the full guide is behind `--full`. Production callers should prefer PrintQuickStart.
Types ¶
This section is empty.
Source Files