Rclone config command

Last updated on 2025-03-04 | Edit this page

Estimated time: 20 minutes

Overview

Questions

  • Once installed, how is Rclone setup or configured?
  • How to check for and edit existing configurations
  • what is a remote/headless machine

Objectives

  • Use config to create remote connections
  • Knowledge of useful command flags (or ‘options’)
  • Configure a remote connection for a machine with no browser available (ie. headless)

Rclone config command:

The *rclone config” command enteres an interactive configuration session where you can setup new remotes, edit and manage existing ones.

syntax:

Rclone config [flags]

rclone config
sand

BASH 

rclone config

OUTPUT 

output goes here
rclone config edit
rclone config edit

Rclone command flags

There are numerous command flags but these three are especially worth remembering:

  • -n, –dry-run Do a trial run with no permanent changes
  • -i, –interactive Enable interactive mode
  • -v, –verbose count Print lots more stuff (repeat for more) - useful when debugging

[live-code a setting up a simple remote]

Walk through configuring a local machine

Walk through configuring a remote that requires authorization

Configuring rclone on a remote/headless machine

A headless machine is one that has no browser available. For example you are using Windows WSL2 Linux subsystem or you logged into a remote machine (HPC, AWS, etc.) using your termnial client.

Some of the configurations (those involving oauth2) require an Internet connected web browser.

We are going to walk through this but here is an example from the Rclone documentation https://rclone.org/remote_setup/#configuring-using-rclone-authorize.

rclone config with headless machine
rclone config with headless machine

Documentation Specific to Remote

Rclone includes extensive documentation that is specific to particular remotes.

Examples:

Reference

https://rclone.org/remote_setup/

https://rclone.org/commands/rclone_config/

https://rclone.org/flags/#important

Key Points

  • Understand how configuration is used.
  • Familiar with useful command flags: dry-run, interactive and verbose.
  • Use config to create remote connections
  • Know where to get help.