putiosync

README

putio-sync

Command-line program to sync a folder between put.io and your computer.

WARNING: The project is still in development and features are subject to change!

If you are using MacOS or Windows, you can install desktop version: putio-sync-desktop.

Installing

If you are on MacOS you can install from brew:

brew install putdotio/putio-sync/putio-sync

Otherwise, get the latest binary from releases page.

Usage

Run the program with your account credentials:

PUTIO_Username=<username> PUTIO_Password=<password> putio-sync

Then program is going to sync the contents of these folders:

• $HOME/putio-sync in your computer
• /putio-sync in your Put.io account

The folders are created if they don't exist. Files will be synced periodically or when a change has been detected.

Documentation

Index

• Variables
• func Sync(ctx context.Context, config Config) error
• type Config
  • func (c *Config) Read(configPath string) error
• type ConfigError
  • func (e *ConfigError) Error() string

Variables

var ErrInvalidCredentials = errors.New("invalid credentials")

Functions

func Sync

func Sync(ctx context.Context, config Config) error

Types

type Config

type Config struct {
	// Username of put.io account.
	Username string
	// Password of put.io account.
	// An OAuth token can be used instead of password.
	// Token must be prefixed with "token/" (without quotes).
	// In that case, Username is not required.
	Password string
	// Sync files to/from this dir in computer.
	LocalDir string
	// Do not make changes on filesystems. Only calculate what needs to be done.
	DryRun bool
	// Stop after first sync operation.
	// Otherwise, sync operation is repeated continuously while waiting for some duration between syncs.
	// If there is authentication error, Sync also returns since there is no point in retrying in this case.
	Once bool
	// Listen address for HTTP server.
	// The server has an endpoint for getting the status of the sync operation.
	Server string
	// Set log level to debug.
	Debug bool
}

func (*Config) Read

func (c *Config) Read(configPath string) error

type ConfigError

type ConfigError struct {
	Reason string
}

func (*ConfigError) Error

func (e *ConfigError) Error() string