metalhostcli

Documentation

Overview

Package metalhostcli is the customer-facing entry point for the Metalhost CLI library. The `metalhost` binary in this repo is a thin wrapper around NewRootCommand below.

What's actually here is glue: this file aliases the proto-free helpers from pkg/metalhostcli/runtime, then layers the customer command tree (vm, disk, network, ...) on top via internal/command.

Internal admin tools should import the `runtime` sub-package directly so they don't pick up customer proto descriptors transitively. See that package's doc comment for the reason.

Index

• func NewRootCommand(opts Options) *cobra.Command
• type Options
• type Profile
• type Runtime
  • func RuntimeFromCommand(cmd *cobra.Command, userAgent string) (*Runtime, error)

Functions

func NewRootCommand

func NewRootCommand(opts Options) *cobra.Command

NewRootCommand builds the full customer CLI: bare root from the runtime package, plus the customer command tree (vm, disk, network, ...) attached from internal/command.

Types

type Options

type Options = runtime.Options

Options re-exports runtime.Options so callers can keep using `metalhostcli.Options{...}` literals without depending on the runtime sub-package directly.

type Profile

type Profile = runtime.Profile

Profile re-exports runtime.Profile (the config-file profile shape).

type Runtime

type Runtime = runtime.Runtime

Runtime re-exports the proto-free runtime helper.

func RuntimeFromCommand

func RuntimeFromCommand(cmd *cobra.Command, userAgent string) (*Runtime, error)

RuntimeFromCommand is a thin pass-through to runtime.RuntimeFromCommand for callers that already import this package.