cli

Documentation

Overview

Package cli contains implementations of CLI commands. The command code is supposed contain only logic specific to the CLI and delegate complex/reusable stuff to code in /internal/commands. Commands in cli package should print results in human-readable format to stdout.

Index

• Constants
• Variables
• func AttachmentDelete(ctx context.Context, spec model.RepoSpec, tmNameOrId, attachmentName string) error
• func AttachmentFetch(ctx context.Context, spec model.RepoSpec, tmNameOrId, attachmentName string) error
• func AttachmentImport(ctx context.Context, spec model.RepoSpec, tmNameOrId, filename string, ...) error
• func AttachmentList(ctx context.Context, spec model.RepoSpec, tmNameOrId string) error
• func CalcFileDigest(filename string) error
• func CheckIndex(ctx context.Context, spec model.RepoSpec) error
• func CheckResources(ctx context.Context, spec model.RepoSpec, names []string) error
• func Copy(ctx context.Context, repo model.RepoSpec, toRepo model.RepoSpec, ...) error
• func CreateSearchParamsFromCLI(flags FilterFlags, name string) *model.SearchParams
• func Delete(ctx context.Context, repo model.RepoSpec, id string) error
• func Export(ctx context.Context, repo model.RepoSpec, search *model.SearchParams, ...) error
• func Fetch(ctx context.Context, repo model.RepoSpec, idOrName, outputPath string, ...) error
• func Index(ctx context.Context, spec model.RepoSpec) error
• func List(ctx context.Context, repo model.RepoSpec, search *model.SearchParams) error
• func ListVersions(ctx context.Context, spec model.RepoSpec, name string) error
• func RepoAdd(name, typ, confStr, confFile, descr string) error
• func RepoList() error
• func RepoRemove(name string) error
• func RepoRename(oldName, newName string) (err error)
• func RepoSetAuth(name, kind, data string) error
• func RepoSetConfig(name, typ, confStr, confFile string, descr string) error
• func RepoShow(name string) error
• func RepoToggleEnabled(name string) error
• func Serve(host, port string, opts ServeOptions, repo model.RepoSpec) error
• func Stderrf(format string, args ...any)
• func ValidateFile(filename string) error
• type CheckResult
  • func (r CheckResult) String() string
• type CheckResultType
  • func (t CheckResultType) String() string
• type FilterFlags
• type ImportExecutor
  • func NewImportExecutor(now commands.Now) *ImportExecutor
  • func (p *ImportExecutor) Import(ctx context.Context, filename string, spec model.RepoSpec, optTree bool, ...) ([]repos.ImportResult, error)
• type ServeOptions

Constants

const (
	CheckOK = CheckResultType(iota)
	CheckErr
)

const DefaultListSeparator = ","

Variables

var ErrInvalidArgs = errors.New("invalid arguments")

var TmcVersion = "n/a"

Functions

func AttachmentDelete

func AttachmentDelete(ctx context.Context, spec model.RepoSpec, tmNameOrId, attachmentName string) error

func AttachmentFetch

func AttachmentFetch(ctx context.Context, spec model.RepoSpec, tmNameOrId, attachmentName string) error

func AttachmentImport

func AttachmentImport(ctx context.Context, spec model.RepoSpec, tmNameOrId, filename string, mediaType string, force bool) error

func AttachmentList

func AttachmentList(ctx context.Context, spec model.RepoSpec, tmNameOrId string) error

func CalcFileDigest

func CalcFileDigest(filename string) error

func CheckIndex

func CheckIndex(ctx context.Context, spec model.RepoSpec) error

func CheckResources

func CheckResources(ctx context.Context, spec model.RepoSpec, names []string) error

func Copy

func Copy(ctx context.Context, repo model.RepoSpec, toRepo model.RepoSpec, search *model.SearchParams, opts repos.ImportOptions) error

func CreateSearchParamsFromCLI

func CreateSearchParamsFromCLI(flags FilterFlags, name string) *model.SearchParams

func Delete

func Delete(ctx context.Context, repo model.RepoSpec, id string) error

func Export

func Export(ctx context.Context, repo model.RepoSpec, search *model.SearchParams, outputPath string, restoreId bool, withAttachments bool) error

func Fetch

func Fetch(ctx context.Context, repo model.RepoSpec, idOrName, outputPath string, restoreId bool) error

func Index

func Index(ctx context.Context, spec model.RepoSpec) error

func List

func List(ctx context.Context, repo model.RepoSpec, search *model.SearchParams) error

func ListVersions

func ListVersions(ctx context.Context, spec model.RepoSpec, name string) error

func RepoAdd

func RepoAdd(name, typ, confStr, confFile, descr string) error

func RepoList

func RepoList() error

func RepoRemove

func RepoRemove(name string) error

func RepoRename

func RepoRename(oldName, newName string) (err error)

func RepoSetAuth

func RepoSetAuth(name, kind, data string) error

func RepoSetConfig

func RepoSetConfig(name, typ, confStr, confFile string, descr string) error

func RepoShow

func RepoShow(name string) error

func RepoToggleEnabled

func RepoToggleEnabled(name string) error

func Serve

func Serve(host, port string, opts ServeOptions, repo model.RepoSpec) error

func Stderrf

func Stderrf(format string, args ...any)

Stderrf prints a message to os.Stderr, followed by newline

func ValidateFile

func ValidateFile(filename string) error

Types

type CheckResult

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

func (CheckResult) String

func (r CheckResult) String() string

type CheckResultType

type CheckResultType int

func (CheckResultType) String

func (t CheckResultType) String() string

type FilterFlags

type FilterFlags struct {
	FilterAuthor       string
	FilterManufacturer string
	FilterMpn          string
	Search             string
}

type ImportExecutor

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

func NewImportExecutor

func NewImportExecutor(now commands.Now) *ImportExecutor

func (*ImportExecutor) Import

func (p *ImportExecutor) Import(ctx context.Context, filename string, spec model.RepoSpec, optTree bool, opts repos.ImportOptions) ([]repos.ImportResult, error)

Import imports file or directory into the specified repository Returns the list of import results up to the first encountered error, and the error

type ServeOptions

type ServeOptions struct {
	UrlCtxRoot string
	cors.CORSOptions
	jwt.JWTValidationOpts
	JWTValidation bool
}