package
1.64.0-Personal
Repository: https://github.com/dceldran/rclone.git
Documentation: pkg.go.dev

# Packages

Package configfile implements a config file loader and saver.
Package configflags defines the flags used by rclone.
Package configmap provides an abstraction for reading and writing config.
Package configstruct parses unstructured maps into structures.
Package flags contains enhanced versions of spf13/pflag flag routines which will read from the environment also.
Package obscure contains the Obscure and Reveal commands.

# Functions

Authorize is for remote authorization of headless machines.
ChangePassword will query the user twice for the named password.
Choose one of the choices, or default, or type a new string if newOk is set.
ChooseNumber asks the user to enter a number between min and max inclusive prompting them with what.
ChooseOption asks the user to choose an option.
ChoosePassword asks the user for a password.
ChooseRemote chooses a remote name.
ClearConfigPassword sets the current the password to empty.
Command - choose one.
CommandDefault - choose one.
Confirm asks the user for Yes or No and returns true or false If the user presses enter then the Default will be used.
CopyRemote copies a config section.
CreateRemote creates a new remote with name, type and a list of parameters which are key, value pairs.
Data returns current config file storage.
Decrypt will automatically decrypt a reader.
DeleteRemote gets the user to delete a remote.
Dump dumps all the config as a JSON file.
DumpRcBlob dumps all the config as an unstructured blob suitable for the rc.
DumpRcRemote dumps the config for a single remote.
EditConfig edits the config file interactively.
EditRemote gets the user to edit a remote.
Encrypt the config file.
Enter prompts for an input value of a specified type.
FileDeleteKey deletes the config key in the config file.
FileGet gets the config key under section returning the default if not set.
FileGetFlag gets the config key under section returning the the value and true if found and or ("", false) otherwise.
FileSections returns the sections in the config file including any defined by environment variables.
FileSet sets the key in section to value.
GetCacheDir returns the default directory for cache The directory is neither guaranteed to exist nor have accessible permissions.
GetConfigPath returns the current config file path.
GetPassword asks the user for a password with the prompt given.
JSONListProviders prints all the providers and options in JSON format.
LoadedData ensures the config file storage is loaded and returns it.
NewRemote make a new remote from its name.
NewRemoteName asks the user for a name for a new remote.
OkRemote prints the contents of the remote and ask if it is OK.
PasswordRemote adds the keyValues passed in to the remote of name.
PostConfig configures the backend after the main config has been done The is the user interface loop that drives the post configuration backend config.
ReadNonEmptyLine prints prompt and calls Readline until non empty.
ReadPassword reads a password without echoing it to the terminal.
RemoteConfig runs the config helper for the remote if needed.
RenameRemote renames a config section.
SaveConfig calling function which saves configuration file.
SetCacheDir sets new default directory for cache.
SetConfigPassword will set the configKey to the hash of the password.
SetConfigPath sets new config file path Checks for empty string, os null device, or special path, all of which indicates in-memory config.
SetData sets new config file storage.
SetPassword will allow the user to modify the current configuration encryption settings.
SetTempDir sets new default directory to use for temporary files.
SetValueAndSave sets the key to the value and saves just that value in the config file.
ShowConfig prints the (unencrypted) config options.
ShowConfigLocation prints the location of the config file in use.
ShowRemote shows the contents of the remote in config file format.
ShowRemotes shows an overview of the config file.
UpdateRemote adds the keyValues passed in to the remote of name.

# Constants

ConfigAuthNoBrowser indicates that we do not want to open browser.
ConfigAuthorize indicates that we just want "rclone authorize".
ConfigAuthURL is the config key used to store the auth server endpoint.
ConfigClientID is the config key used to store the client id.
ConfigClientSecret is the config key used to store the client secret.
ConfigEncoding is the config key to change the encoding for a backend.
ConfigEncodingHelp is the help for ConfigEncoding.
ConfigTemplate is the template content to be used in the authorization webserver.
ConfigTemplateFile is the path to a template file to read into the value of `ConfigTemplate` above.
ConfigToken is the key used to store the token under.
ConfigTokenURL is the config key used to store the token server endpoint.

# Variables

ErrorConfigFileNotFound is returned when the config file is not found.
PassConfigKeyForDaemonization if set to true, the configKey is obscured with obscure.Obscure and saved to a temp file when it is calculated from the password.
Password can be used to configure the random password generator.
PasswordPromptOutput is output of prompt for password.
ReadLine reads some input.

# Structs

UpdateRemoteOpt configures the remote update.

# Interfaces

Storage defines an interface for loading and saving config to persistent storage.