Documentation
¶
Overview ¶
Package console renders calm, human-readable messages for Hikyo's terminal surfaces. Structured operational events remain the responsibility of slog.
Index ¶
- func AboutMessage(info VersionInfo) string
- func FullArtwork() string
- func ServerReadyMessage(info ServerInfo) string
- func UpdateAvailableMessage(info UpdateInfo) string
- func UpdateCheckMessage(channel string) string
- func UpdateCurrentMessage(info UpdateInfo) string
- func VersionMessage(info VersionInfo) string
- func WelcomeMessage(info VersionInfo) string
- type ServerInfo
- type UpdateInfo
- type VersionInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AboutMessage ¶
func AboutMessage(info VersionInfo) string
AboutMessage renders the explicit product-information screen.
func FullArtwork ¶
func FullArtwork() string
FullArtwork returns the byte-exact supplied logo for explicit display commands.
func ServerReadyMessage ¶
func ServerReadyMessage(info ServerInfo) string
ServerReadyMessage renders the summary shown after both listeners bind.
func UpdateAvailableMessage ¶
func UpdateAvailableMessage(info UpdateInfo) string
UpdateAvailableMessage renders a new release and the action target.
func UpdateCheckMessage ¶
UpdateCheckMessage renders progress before the release source is queried.
func UpdateCurrentMessage ¶
func UpdateCurrentMessage(info UpdateInfo) string
UpdateCurrentMessage renders a successful check with no newer release.
func VersionMessage ¶
func VersionMessage(info VersionInfo) string
VersionMessage renders the human-facing output of `hikyo version`.
func WelcomeMessage ¶
func WelcomeMessage(info VersionInfo) string
WelcomeMessage renders the explicit first-contact screen.
Types ¶
type ServerInfo ¶
type ServerInfo struct {
Version string
AppURL string
ListenAddress string
OperationalURL string
CLISocket string
Mode string
}
ServerInfo describes the endpoints and mode of a ready server process.
type UpdateInfo ¶
UpdateInfo describes the installed and selected Hikyo release.
type VersionInfo ¶
VersionInfo describes one Hikyo binary build.