cmd

Documentation

Index

• Variables
• func ApplyDefaultHostAndPortToAddr(address, defaultAddress string) (string, error)
• func ApplyDefaultHostAndPortToAddrFlag(cmd *cobra.Command, flagName string) error
• type UplinkFlags
  • func (cliCfg *UplinkFlags) GetProject(ctx context.Context) (*libuplink.Project, error)
  • func (cliCfg *UplinkFlags) GetProjectAndBucket(ctx context.Context, bucketName string, access *libuplink.EncryptionAccess) (project *libuplink.Project, bucket *libuplink.Bucket, err error)
  • func (cliCfg *UplinkFlags) NewUplink(ctx context.Context) (*libuplink.Uplink, error)

Variables

var (

	// Error is the class of errors returned by this package
	Error = errs.Class("uplink")
)

var RootCmd = &cobra.Command{
	Use:                "uplink",
	Short:              "The Storj client-side CLI",
	Args:               cobra.OnlyValidArgs,
	PersistentPreRunE:  startCPUProfile,
	PersistentPostRunE: stopAndWriteProfile,
}

RootCmd represents the base CLI command when called without any subcommands

Functions

func ApplyDefaultHostAndPortToAddr

func ApplyDefaultHostAndPortToAddr(address, defaultAddress string) (string, error)

ApplyDefaultHostAndPortToAddr applies the default host and/or port if either is missing in the specified address.

func ApplyDefaultHostAndPortToAddrFlag

func ApplyDefaultHostAndPortToAddrFlag(cmd *cobra.Command, flagName string) error

ApplyDefaultHostAndPortToAddrFlag applies the default host and/or port if either is missing in the specified flag name.

Types

type UplinkFlags

type UplinkFlags struct {
	NonInteractive bool `help:"disable interactive mode" default:"false" setup:"true"`
	uplink.Config

	Version version.Config
}

UplinkFlags configuration flags

func (*UplinkFlags) GetProject

func (cliCfg *UplinkFlags) GetProject(ctx context.Context) (*libuplink.Project, error)

GetProject returns a *libuplink.Project for interacting with a specific project

func (*UplinkFlags) GetProjectAndBucket

func (cliCfg *UplinkFlags) GetProjectAndBucket(ctx context.Context, bucketName string, access *libuplink.EncryptionAccess) (project *libuplink.Project, bucket *libuplink.Bucket, err error)

GetProjectAndBucket returns a *libuplink.Bucket for interacting with a specific project's bucket

func (*UplinkFlags) NewUplink

func (cliCfg *UplinkFlags) NewUplink(ctx context.Context) (*libuplink.Uplink, error)

NewUplink returns a pointer to a new Client with a Config and Uplink pointer on it and an error.