cmd

Documentation

Overview

Package cmd implements the rclone command

It is in a sub package so it's internals can be re-used elsewhere

Index

• Variables
• func AddBackendFlags()
• func CheckArgs(MinArgs, MaxArgs int, cmd *cobra.Command, args []string)
• func Main()
• func NewFsDir(args []string) fs.Fs
• func NewFsDstFile(args []string) (fdst fs.Fs, dstFileName string)
• func NewFsFile(remote string) (fs.Fs, string)
• func NewFsSrc(args []string) fs.Fs
• func NewFsSrcDst(args []string) (fs.Fs, fs.Fs)
• func NewFsSrcDstFiles(args []string) (fsrc fs.Fs, srcFileName string, fdst fs.Fs, dstFileName string)
• func NewFsSrcFileDst(args []string) (fsrc fs.Fs, srcFileName string, fdst fs.Fs)
• func Run(Retry bool, showStats bool, cmd *cobra.Command, f func() error)
• func ShowStats() bool
• func ShowVersion()
• func SigInfoHandler()
• func StartStats() func()

Variables

var GeneratingDocs = false

GeneratingDocs is set by rclone gendocs to alter the format of the output suitable for the documentation.

var Root = &cobra.Command{
	Use:   "rclone",
	Short: "Show help for rclone commands, flags and backends.",
	Long: `
Rclone syncs files to and from cloud storage providers as well as
mounting them, listing them in lots of different ways.

See the home page (https://rclone.org/) for installation, usage,
documentation, changelog and configuration walkthroughs.

`,
	PersistentPostRun: func(cmd *cobra.Command, args []string) {
		fs.Debugf("rclone", "Version %q finishing with parameters %q", fs.Version, os.Args)
		atexit.Run()
	},
	BashCompletionFunction: bashCompletionFunc,
	DisableAutoGenTag:      true,
}

Root is the main rclone command

Functions

func AddBackendFlags

func AddBackendFlags()

AddBackendFlags creates flags for all the backend options

func CheckArgs

func CheckArgs(MinArgs, MaxArgs int, cmd *cobra.Command, args []string)

CheckArgs checks there are enough arguments and prints a message if not

func Main

func Main()

Main runs rclone interpreting flags and commands out of os.Args

func NewFsDir

func NewFsDir(args []string) fs.Fs

NewFsDir creates a new Fs from the arguments

The argument must point a directory

func NewFsDstFile

func NewFsDstFile(args []string) (fdst fs.Fs, dstFileName string)

NewFsDstFile creates a new dst fs with a destination file name from the arguments

func NewFsFile

func NewFsFile(remote string) (fs.Fs, string)

NewFsFile creates an Fs from a name but may point to a file.

It returns a string with the file name if points to a file otherwise "".

func NewFsSrc

func NewFsSrc(args []string) fs.Fs

NewFsSrc creates a new src fs from the arguments.

The source can be a file or a directory - if a file then it will limit the Fs to a single file.

func NewFsSrcDst

func NewFsSrcDst(args []string) (fs.Fs, fs.Fs)

NewFsSrcDst creates a new src and dst fs from the arguments

func NewFsSrcDstFiles

func NewFsSrcDstFiles(args []string) (fsrc fs.Fs, srcFileName string, fdst fs.Fs, dstFileName string)

NewFsSrcDstFiles creates a new src and dst fs from the arguments If src is a file then srcFileName and dstFileName will be non-empty

func NewFsSrcFileDst

func NewFsSrcFileDst(args []string) (fsrc fs.Fs, srcFileName string, fdst fs.Fs)

NewFsSrcFileDst creates a new src and dst fs from the arguments

The source may be a file, in which case the source Fs and file name is returned

func Run

func Run(Retry bool, showStats bool, cmd *cobra.Command, f func() error)

Run the function with stats and retries if required

func ShowStats

func ShowStats() bool

ShowStats returns true if the user added a `--stats` flag to the command line.

This is called by Run to override the default value of the showStats passed in.

func ShowVersion

func ShowVersion()

ShowVersion prints the version to stdout

func SigInfoHandler

func SigInfoHandler()

SigInfoHandler creates SigInfo handler

func StartStats

func StartStats() func()

StartStats prints the stats every statsInterval

It returns a func which should be called to stop the stats.