cli

Documentation

Overview

Package cli contains functionality for the command-line interface of the service. It provides commands for starting both the server and scheduler services.

Index

• type Args
• type Arguments
  • func AddArguments(options ...Option) *Arguments
• type BlockUserCmd
  • func (c *BlockUserCmd) Run() error
• type ClearSchedulerCmd
  • func (c *ClearSchedulerCmd) Run(opts *Arguments) error
• type DataCmd
• type DeleteCmd
  • func (c *DeleteCmd) Run(opts *DeleteCmd) error
• type DeleteUserCmd
  • func (c *DeleteUserCmd) Run() error
• type InitSchedulerCmd
  • func (c *InitSchedulerCmd) Run(opts *Arguments) error
• type MigrateCmd
  • func (r *MigrateCmd) Run(opts *MigrateCmd) error
• type Option
  • func WithEnvironment(env string) Option
  • func WithLogger(logger *slog.Logger) Option
• type RunSchedulerCmd
  • func (c *RunSchedulerCmd) Run(opts *Arguments) error
• type SchedulerCmd
• type SchemaCmd
• type ServeCmd
  • func (r *ServeCmd) Run(opts *Arguments) error
• type UpdateCmd
  • func (r *UpdateCmd) Run(opts *UpdateCmd) error
• type UserCmd

Types

type Args

type Args struct {
	UserID models.UserID `arg:"" help:"ID of object to delete"`
}

type Arguments

type Arguments struct {
	// Logger is a logger that the command can use.
	Logger *slog.Logger
	// StaticContent is an embedded filesystem containing static files.
	StaticContent embed.FS
	// Environment is the running environment for the application.
	Environment string
}

Arguments are the common options for commands.

func AddArguments

func AddArguments(options ...Option) *Arguments

AddArguments generates command-line arguments from the given options.

type BlockUserCmd

type BlockUserCmd struct {
	Args
	Value bool `help:"Block status."`
}

func (*BlockUserCmd) Run

func (c *BlockUserCmd) Run() error

type ClearSchedulerCmd

type ClearSchedulerCmd struct{}

func (*ClearSchedulerCmd) Run

func (c *ClearSchedulerCmd) Run(opts *Arguments) error

Run runs the clear command that will remove all scheduled jobs.

type DataCmd

type DataCmd struct {
	Delete DeleteCmd `cmd:"delete" help:"Delete objects"`
}

DataCmd defines the `data` command, which contains commands for manipulating data.

type DeleteCmd

type DeleteCmd struct {
	ObjectID string `arg:"" help:"ID of object to delete"`
}

func (*DeleteCmd) Run

func (c *DeleteCmd) Run(opts *DeleteCmd) error

type DeleteUserCmd

type DeleteUserCmd struct {
	Args
}

func (*DeleteUserCmd) Run

func (c *DeleteUserCmd) Run() error

type InitSchedulerCmd

type InitSchedulerCmd struct{}

func (*InitSchedulerCmd) Run

func (c *InitSchedulerCmd) Run(opts *Arguments) error

Run runs the clear command that will remove all scheduled jobs.

type MigrateCmd

type MigrateCmd struct {
	schema.Options
}

func (*MigrateCmd) Run

func (r *MigrateCmd) Run(opts *MigrateCmd) error

type Option

type Option func(*Arguments) *Arguments

Option is a functional option for the command-line.

func WithEnvironment

func WithEnvironment(env string) Option

WithEnvironment option sets the environment for the command.

func WithLogger

func WithLogger(logger *slog.Logger) Option

WithLogger defines a logger for a command.

type RunSchedulerCmd

type RunSchedulerCmd struct{}

func (*RunSchedulerCmd) Run

func (c *RunSchedulerCmd) Run(opts *Arguments) error

Run contains logic for setup and execution of the scheduler.

type SchedulerCmd

type SchedulerCmd struct {
	Run   RunSchedulerCmd   `cmd:"run"   help:"Run scheduler."`
	Clear ClearSchedulerCmd `cmd:"clear" help:"Clear all jobs."`
	Init  InitSchedulerCmd  `cmd:"init"  help:"Initialise the scheduler/queue."`
}

SchedulerCmd defines the `scheduler` command, for running the job scheduler.

type SchemaCmd

type SchemaCmd struct {
	Update  UpdateCmd  `cmd:"update"  help:"Update schema(s)"`
	Migrate MigrateCmd `cmd:"migrate" help:"Migrate schema(s)"`
}

type ServeCmd

type ServeCmd struct{}

ServeCmd defines the `server` command for running the server.

func (*ServeCmd) Run

func (r *ServeCmd) Run(opts *Arguments) error

Run performs setup and execution for the server command.

type UpdateCmd

type UpdateCmd struct {
	schema.Options
}

func (*UpdateCmd) Run

func (r *UpdateCmd) Run(opts *UpdateCmd) error

type UserCmd

type UserCmd struct {
	Delete DeleteUserCmd `cmd:"delete" help:"Delete user"`
	Block  BlockUserCmd  `cmd:"delete" help:"Block user"`
}

UserCmd contains sub commands for managing users.