Documentation
¶
Overview ¶
Package publicpath is the single source of the commands the public install text prints: the install command, the init command a fresh workspace accepts and the steps that follow it. The CLI hints, the published documents and the public-package proof all derive from public-path.json, so the text a person copies and the product that runs it cannot drift apart (scripts/docs/public-path.mjs rewrites and checks the published copies).
Index ¶
- func AccessEvidence() string
- func CLIOnlyInstallCommand() string
- func ConnectCommand() string
- func CustodyRepairCommand(specPath string) string
- func DefaultKit() string
- func EmailPlaceholder() string
- func ExampleEmail() string
- func InitCommand(o InitOptions) string
- func InstallCommand() string
- func InstallerResult() []string
- func QuickStart() []string
- type InitOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AccessEvidence ¶
func AccessEvidence() string
AccessEvidence is the file that names the first reachable app.
func CLIOnlyInstallCommand ¶
func CLIOnlyInstallCommand() string
CLIOnlyInstallCommand is the install command that stops after the CLI and the public kit catalog, without installing a kit.
func ConnectCommand ¶
func ConnectCommand() string
ConnectCommand is the offer at the end of the public path: bind this server to the kombify account that created the pairing (stackkit connect).
func CustodyRepairCommand ¶
CustodyRepairCommand establishes the local owner for a workspace that holds a StackSpec and no owner custody. It re-persists the spec unchanged, so no expected spec hash and no new selection are needed.
func DefaultKit ¶
func DefaultKit() string
DefaultKit is the Kit `stackkit init` selects when none is named.
func EmailPlaceholder ¶
func EmailPlaceholder() string
EmailPlaceholder is the owner address placeholder agent text shows.
func ExampleEmail ¶
func ExampleEmail() string
ExampleEmail is the owner address the published text shows.
func InitCommand ¶
func InitCommand(o InitOptions) string
InitCommand renders the init command a fresh workspace accepts: a Kit selection, the local owner and the owner address the local PocketID owner needs.
func InstallerResult ¶
func InstallerResult() []string
InstallerResult is what a person runs after the one-command installer has finished: into the workspace it created, then the checks that show the result.
func QuickStart ¶
func QuickStart() []string
QuickStart is the published command chain after the install command: the workspace, the init command and the steps that follow it up to the access evidence of the first reachable app.
Types ¶
type InitOptions ¶
type InitOptions struct {
// Kit is omitted from the command when empty (init then selects the default Kit).
Kit string
// Email defaults to the example address.
Email string
// Domain adds the domain flag when non-empty.
Domain string
NonInteractive bool
}
InitOptions selects the parts of a published init command.
Source Files