cmd

Documentation

Index

• func UnmarshalEntities[TEntity any](cli *Cli, args []string, format string) (entities []*TEntity, err error)
• type Cli
  • func NewCli(options ...CliOption) (cli *Cli, err error)
  • func (cli *Cli) Execute() error
  • func (cli *Cli) PersistentPreRun(cmd *cobra.Command, args []string)
• type CliOption
  • func WithAll() CliOption
  • func WithBNTPBackend() CliOption
  • func WithBookmarkCommand() CliOption
  • func WithBookmarkTypeCommand() CliOption
  • func WithConfigCommand() CliOption
  • func WithConfigManager() CliOption
  • func WithDbOverride(dbToUse *sql.DB) CliOption
  • func WithDocumentCommand() CliOption
  • func WithDocumentTypeCommand() CliOption
  • func WithFsOverride(fsToUse afero.Fs) CliOption
  • func WithStdErrOverride(stderrToUse io.Writer) CliOption
  • func WithTagCommand() CliOption
• type ConflictingPositionalArgsAndFlagError
  • func (err ConflictingPositionalArgsAndFlagError) As(target any) bool
  • func (err ConflictingPositionalArgsAndFlagError) Error() string
  • func (err ConflictingPositionalArgsAndFlagError) Is(other error) bool
• type Count
• type DoesExist
• type EntityMarshallingError
  • func (err EntityMarshallingError) As(target any) bool
  • func (err EntityMarshallingError) Error() string
  • func (err EntityMarshallingError) Is(other error) bool
  • func (err EntityMarshallingError) Unwrap() error
• type NumAffectedRecords

Functions

func UnmarshalEntities

func UnmarshalEntities[TEntity any](cli *Cli, args []string, format string) (entities []*TEntity, err error)

Types

type Cli

type Cli struct {
	ConfigManager *config.ConfigManager
	BNTPBackend   *backend.Backend
	InFormat      string
	OutFormat     string
	FilterRaw     string
	UpdaterRaw    string
	PathFormat    bool
	ShortFormat   bool
	DebugMode     bool
	StdErr        io.Writer
	DBOverride    *sql.DB
	Logger        *log.Logger
	FsOverride    afero.Fs
	Fs            afero.Fs

	BookmarkAddCmd        *cobra.Command
	BookmarkCmd           *cobra.Command
	BookmarkCountCmd      *cobra.Command
	BookmarkDoesExistCmd  *cobra.Command
	BookmarkEditCmd       *cobra.Command
	BookmarkFindCmd       *cobra.Command
	BookmarkListCmd       *cobra.Command
	BookmarkRemoveCmd     *cobra.Command
	BookmarkReplaceCmd    *cobra.Command
	BookmarkTypeAddCmd    *cobra.Command
	BookmarkTypeCmd       *cobra.Command
	BookmarkTypeEditCmd   *cobra.Command
	BookmarkTypeRemoveCmd *cobra.Command
	BookmarkTypeListCmd   *cobra.Command
	BookmarkUpsertCmd     *cobra.Command

	ConfigCmd               *cobra.Command
	ConfigExtensionsCmd     *cobra.Command
	ConfigPathsCmd          *cobra.Command
	ConfigGetSchemaCmd      *cobra.Command
	ConfigGetDBProvidersCmd *cobra.Command
	DocumentAddCmd          *cobra.Command
	DocumentCmd             *cobra.Command
	DocumentCountCmd        *cobra.Command
	DocumentDoesExistCmd    *cobra.Command
	DocumentEditCmd         *cobra.Command
	DocumentFindCmd         *cobra.Command
	DocumentListCmd         *cobra.Command
	DocumentRemoveCmd       *cobra.Command
	DocumentReplaceCmd      *cobra.Command
	DocumentTypeAddCmd      *cobra.Command
	DocumentTypeCmd         *cobra.Command
	DocumentTypeEditCmd     *cobra.Command
	DocumentTypeRemoveCmd   *cobra.Command
	DocumentTypeListCmd     *cobra.Command
	DocumentUpsertCmd       *cobra.Command

	RootCmd         *cobra.Command
	TagAddCmd       *cobra.Command
	TagAmbiguousCmd *cobra.Command
	TagCmd          *cobra.Command
	TagCountCmd     *cobra.Command
	TagDoesExistCmd *cobra.Command
	TagEditCmd      *cobra.Command
	TagExportCmd    *cobra.Command
	TagFindCmd      *cobra.Command
	TagImportCmd    *cobra.Command
	TagListCmd      *cobra.Command
	TagRemoveCmd    *cobra.Command
	TagReplaceCmd   *cobra.Command
	TagShortCmd     *cobra.Command
	TagUpsertCmd    *cobra.Command
	// contains filtered or unexported fields
}

func NewCli

func NewCli(options ...CliOption) (cli *Cli, err error)

func (*Cli) Execute

func (cli *Cli) Execute() error

func (*Cli) PersistentPreRun

func (cli *Cli) PersistentPreRun(cmd *cobra.Command, args []string)

type CliOption

type CliOption func(*Cli) error

func WithAll

func WithAll() CliOption

func WithBNTPBackend

func WithBNTPBackend() CliOption

func WithBookmarkCommand

func WithBookmarkCommand() CliOption

func WithBookmarkTypeCommand

func WithBookmarkTypeCommand() CliOption

func WithConfigCommand

func WithConfigCommand() CliOption

func WithConfigManager

func WithConfigManager() CliOption

func WithDbOverride

func WithDbOverride(dbToUse *sql.DB) CliOption

func WithDocumentCommand

func WithDocumentCommand() CliOption

func WithDocumentTypeCommand

func WithDocumentTypeCommand() CliOption

func WithFsOverride

func WithFsOverride(fsToUse afero.Fs) CliOption

func WithStdErrOverride

func WithStdErrOverride(stderrToUse io.Writer) CliOption

func WithTagCommand

func WithTagCommand() CliOption

type ConflictingPositionalArgsAndFlagError

type ConflictingPositionalArgsAndFlagError struct {
	Flag string
}

func (ConflictingPositionalArgsAndFlagError) As

func (err ConflictingPositionalArgsAndFlagError) As(target any) bool

func (ConflictingPositionalArgsAndFlagError) Error

func (err ConflictingPositionalArgsAndFlagError) Error() string

func (ConflictingPositionalArgsAndFlagError) Is

func (err ConflictingPositionalArgsAndFlagError) Is(other error) bool

type Count

type Count struct {
	Count int64 `json:"count"`
}

type DoesExist

type DoesExist struct {
	DoesExist bool `json:"doesExist"`
}

type EntityMarshallingError

type EntityMarshallingError struct {
	Inner error
}

func (EntityMarshallingError) As

func (err EntityMarshallingError) As(target any) bool

func (EntityMarshallingError) Error

func (err EntityMarshallingError) Error() string

func (EntityMarshallingError) Is

func (err EntityMarshallingError) Is(other error) bool

func (EntityMarshallingError) Unwrap

func (err EntityMarshallingError) Unwrap() error

type NumAffectedRecords

type NumAffectedRecords struct {
	NumAffectedRecords int64 `json:"numAffectedRecords"`
}