cmd

Documentation

Index

• Variables
• func RunClient(opts ...fx.Option) error
• func RunServer(opts ...fx.Option) error
• type Command
  • func New(version string) *Command
  • func (c *Command) AddClient(opts ...fx.Option) *cobra.Command
  • func (c *Command) AddClientCommand(name, description string, opts ...fx.Option) *cobra.Command
  • func (c *Command) AddServer(opts ...fx.Option) *cobra.Command
  • func (c *Command) AddServerCommand(name, description string, opts ...fx.Option) *cobra.Command
  • func (c *Command) Run() error
  • func (c *Command) RunWithArgs(args []string) error
• type Config
  • func NewConfig(flag string, factory *marshaller.Factory) (*Config, error)
  • func (c *Config) Kind() string
  • func (c *Config) Unmarshal(data any) error
  • func (c *Config) Write(data []byte, mode fs.FileMode) error
• type ENV
  • func NewENV(location string) *ENV
  • func (e *ENV) Kind() string
  • func (e *ENV) Read() ([]byte, error)
  • func (e *ENV) Write(data []byte, mode fs.FileMode) error
• type File
  • func NewFile(location string) *File
  • func (f *File) Kind() string
  • func (f *File) Read() ([]byte, error)
  • func (f *File) Write(data []byte, mode fs.FileMode) error
• type InputConfig
  • func NewInputConfig(factory *marshaller.Factory) (*InputConfig, error)
• type ReaderWriter

Variables

var (
	// ErrInvalidKind for cmd.
	ErrInvalidKind = errors.New("invalid kind")
)

var Module = fx.Options(fx.Provide(NewInputConfig))

Module for fx.

Functions

func RunClient

func RunClient(opts ...fx.Option) error

RunClient with args and a timeout.

func RunServer

func RunServer(opts ...fx.Option) error

RunServer with args and a timeout.

Types

type Command

type Command struct {
	// contains filtered or unexported fields
}

Command for application.

func New

func New(version string) *Command

New command.

func (*Command) AddClient

func (c *Command) AddClient(opts ...fx.Option) *cobra.Command

AddClient to the command.

func (*Command) AddClientCommand

func (c *Command) AddClientCommand(name, description string, opts ...fx.Option) *cobra.Command

AddClientCommand to root.

func (*Command) AddServer

func (c *Command) AddServer(opts ...fx.Option) *cobra.Command

AddServer to the command.

func (*Command) AddServerCommand

func (c *Command) AddServerCommand(name, description string, opts ...fx.Option) *cobra.Command

AddServerCommand to root.

func (*Command) Run

func (c *Command) Run() error

Run the command.

func (*Command) RunWithArgs

func (c *Command) RunWithArgs(args []string) error

Run the command with a an arg.

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config for cmd.

func NewConfig

func NewConfig(flag string, factory *marshaller.Factory) (*Config, error)

NewConfig for cmd.

func (*Config) Kind

func (c *Config) Kind() string

Kind of config.

func (*Config) Unmarshal

func (c *Config) Unmarshal(data any) error

Unmarshal for config.

func (*Config) Write

func (c *Config) Write(data []byte, mode fs.FileMode) error

Write for config.

type ENV

type ENV struct {
	// contains filtered or unexported fields
}

ENV for cmd.

func NewENV

func NewENV(location string) *ENV

NewENV for cmd.

func (*ENV) Kind

func (e *ENV) Kind() string

Write for env.

func (*ENV) Read

func (e *ENV) Read() ([]byte, error)

Read for env.

func (*ENV) Write

func (e *ENV) Write(data []byte, mode fs.FileMode) error

Write for env.

type File

type File struct {
	// contains filtered or unexported fields
}

File for cmd.

func NewFile

func NewFile(location string) *File

NewFile for cmd.

func (*File) Kind

func (f *File) Kind() string

Write for file.

func (*File) Read

func (f *File) Read() ([]byte, error)

Read for file.

func (*File) Write

func (f *File) Write(data []byte, mode fs.FileMode) error

Write for file.

type InputConfig

type InputConfig struct {
	*Config
}

InputConfig for cmd.

func NewInputConfig

func NewInputConfig(factory *marshaller.Factory) (*InputConfig, error)

NewInputConfig for cmd.

type ReaderWriter

type ReaderWriter interface {
	Read() ([]byte, error)
	Write(data []byte, mode fs.FileMode) error
	Kind() string
}

ReaderWriter for cmd.