cmd

Documentation

Index

• Variables
• func CidFlag(usage string) *cli.StringFlag
• func DataFlag(usage string) *cli.StringFlag
• func InputFileFlag() *cli.StringFlag
• func IsHexEncodedFlag() *cli.BoolFlag
• func IsMnemonicEncodedFlag() *cli.BoolFlag
• func KeyName() *cli.StringFlag
• func KeySize() *cli.IntFlag
• func KeyType() *cli.StringFlag
• func LinkCidFlag(usage string) *cli.StringFlag
• func LinkNameFlag(usage string) *cli.StringFlag
• func LoadAPICommands() cli.Commands
• func LoadAdminCommands() cli.Commands
• func LoadClientCommands() cli.Commands
• func LoadExtrasCommands() cli.Commands
• func LoadFileCommands() cli.Commands
• func LoadKeystoreCommands() cli.Commands
• func LoadNameSysCommands() cli.Commands
• func LoadPubSubCommands() cli.Commands
• func LoadUtilCommands() cli.Commands
• func MnemonicFlag() *cli.StringFlag
• func MultiAddrFlag(usage string) *cli.StringFlag
• func MultiHashFlag() *cli.StringFlag
• func ObjectEncodingFlag() *cli.StringFlag
• func OutputFlag() *cli.StringFlag
• func P2pFlags(cmdFlag *cli.StringFlag) []cli.Flag
• func PeerIDFlag(usage string) *cli.StringFlag
• func PrintProgressFlag() *cli.BoolFlag
• func SerializationFormatFlag() *cli.StringFlag
• func SetupCommands(cctx context.Context, ccancel context.CancelFunc)

Variables

var (
	// Version is git commit information at build time
	Version string
)

Functions

func CidFlag

func CidFlag(usage string) *cli.StringFlag

CidFlag is used to indicate the cid to proccess

func DataFlag

func DataFlag(usage string) *cli.StringFlag

DataFlag indicates some arbitrary string data

func InputFileFlag

func InputFileFlag() *cli.StringFlag

InputFileFlag allows reading data from a file

func IsHexEncodedFlag

func IsHexEncodedFlag() *cli.BoolFlag

IsHexEncodedFlag indicates if the data is hex encoded

func IsMnemonicEncodedFlag

func IsMnemonicEncodedFlag() *cli.BoolFlag

IsMnemonicEncodedFlag indicates if the data is encoded as mnemonic

func KeyName

func KeyName() *cli.StringFlag

KeyName indicates the name of the key

func KeySize

func KeySize() *cli.IntFlag

KeySize indicates the size of a key, default size suitable for all but RSA

func KeyType

func KeyType() *cli.StringFlag

KeyType indicates the type of key

func LinkCidFlag

func LinkCidFlag(usage string) *cli.StringFlag

LinkCidFlag indicates the cid of a link

func LinkNameFlag

func LinkNameFlag(usage string) *cli.StringFlag

LinkNameFlag indicates the name of a link in IPLD object management

func LoadAPICommands

func LoadAPICommands() cli.Commands

LoadAPICommands returns an api commands object

func LoadAdminCommands

func LoadAdminCommands() cli.Commands

LoadAdminCommands returns an admin api commands object

func LoadClientCommands

func LoadClientCommands() cli.Commands

LoadClientCommands returns a gRPC client commands object

func LoadExtrasCommands

func LoadExtrasCommands() cli.Commands

LoadExtrasCommands returns an extras commands object

func LoadFileCommands

func LoadFileCommands() cli.Commands

LoadFileCommands returns a file commands object

func LoadKeystoreCommands

func LoadKeystoreCommands() cli.Commands

LoadKeystoreCommands returns keystore management commands

func LoadNameSysCommands

func LoadNameSysCommands() cli.Commands

LoadNameSysCommands returns namesys api commands

func LoadPubSubCommands

func LoadPubSubCommands() cli.Commands

LoadPubSubCommands returns a cli commands object for the grpc pubsub client

func LoadUtilCommands

func LoadUtilCommands() cli.Commands

LoadUtilCommands returns generalized utility commands

func MnemonicFlag

func MnemonicFlag() *cli.StringFlag

MnemonicFlag allows saving data as a mnemonic

func MultiAddrFlag

func MultiAddrFlag(usage string) *cli.StringFlag

MultiAddrFlag indicates the multi address to use

func MultiHashFlag

func MultiHashFlag() *cli.StringFlag

MultiHashFlag enables specifying the multihash to use

func ObjectEncodingFlag

func ObjectEncodingFlag() *cli.StringFlag

ObjectEncodingFlag enables specifying alternate encoding formats for creating objects

func OutputFlag

func OutputFlag() *cli.StringFlag

OutputFlag helps to control the style of output

func P2pFlags

func P2pFlags(cmdFlag *cli.StringFlag) []cli.Flag

P2pFlags are used to control p2p stream takes in an argument which is a command that should be loaded with a default value. This is appended to the default p2p command flag list

func PeerIDFlag

func PeerIDFlag(usage string) *cli.StringFlag

PeerIDFlag indicates the peerID

func PrintProgressFlag

func PrintProgressFlag() *cli.BoolFlag

PrintProgressFlag enables printing the progress of uploads

func SerializationFormatFlag

func SerializationFormatFlag() *cli.StringFlag

SerializationFormatFlag enables specifying alternate serialization formats

func SetupCommands

func SetupCommands(cctx context.Context, ccancel context.CancelFunc)

SetupCommands MUST be called to properly setup the commands repository DEPRECATED: is now a no-op