initialize

package

v0.8.0 Latest Latest Go to latest Published: Aug 31, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/deployah-dev/deployah

Links

Open Source Insights

Documentation ¶

Overview ¶

Package initialize implements the deployah init command.

Init is a TTY-only wizard: it walks through project name, environments, and components, then writes a sparse deployah.yaml (schema defaults omitted), merges missing keys into the platform file, and scaffolds .deployah extras directories. Dry-run mode previews the spec without writing files. There is no non-interactive defaults path.

Register the command with Register on a nabat.dev/nabat.App instance.

Constants ¶

View Source

const (
	// DefaultEnvironmentName is the Kind environment offered in the wizard.
	DefaultEnvironmentName = "local"
)

Variables ¶

This section is empty.

Functions ¶

func Register ¶

func Register(app *nabat.App)

Register adds the init command to app.

Types ¶

type Options ¶

type Options struct {
	DryRun bool `nabat:"dry-run"`
	Force  bool `nabat:"force"`
}

Options holds command-line flags for init.

type ProjectConfig ¶

type ProjectConfig struct {
	Name string
	// EnvironmentNames are registered in the platform file, not in the
	// generated spec: the spec's environments map is overrides-only.
	EnvironmentNames []string
	Components       map[string]spec.Component
	SpecPath         string
	PlatformPath     string
	DryRun           bool
}

ProjectConfig holds the collected configuration data.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL