Documentation
¶
Overview ¶
Package guide writes AGENTS.md — the AI-agent USAGE guide for driving w17ctl — and fetches the w17 PLATFORM reference (w17/specs/*) from the console.
The split is deliberate: AGENTS.md describes w17ctl's OWN commands, so it is client-embedded (only the client authoritatively knows its command surface, and it works offline before login). The platform reference (types, annotations, generation model, event system) describes the COMPILER's output, so it is generated server-side and fetched — an old client never ships an outdated design; when codegen changes, w17/specs/ changes with it.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cmd ¶
type Cmd struct {
Out string `` /* 172-byte string literal not displayed */
Stdout bool `name:"stdout" help:"Print the usage guide to stdout instead of writing files."`
Force bool `name:"force" short:"f" help:"Overwrite FILE if it already exists."`
Console string `` /* 146-byte string literal not displayed */
NoSpecs bool `name:"no-specs" help:"Write only AGENTS.md; skip fetching the server-generated w17/specs/ platform reference."`
}
Cmd writes AGENTS.md (the usage guide) + fetches w17/specs/ (the platform reference). AGENTS.md is the cross-tool convention coding agents read into context automatically. Idempotent: refuses to clobber AGENTS.md unless --force (the server-generated w17/specs/ is always refreshed).
Source Files