Remote Files

A command line and library wrapper of OpenDAL, which allows managing remote files on buckets, such as download and download them.

Currently supported buckets are:

• Google Cloud Storage
• Amazon S3

Remote-files may work also with cloud storage providers that offer an API compatible with GCS or S3, but no guarantees are provided.

Installation

cargo install remote-files

Configuration

In order to use remote-files it is necessary to generate a configuration file that lists all the connection profiles, alongside their credentials details.

The location of this configuration file is governed through environment variable RF_CFG_FILEPATH, whose default value depends on the operating system.

Examples

Here is provided an example of configuration file that defines two different connection profiles, one for Google Cloud Storage and one for Amazon S3.

{
  "my-gcs-bucket": {
    "type": "gcs",
    "configuration": {
      "name": "my-gcs-bucket",
      "credentialPath": "~/.config/gcloud/application_default_credentials.json"
    }
  },
  "my-aws-bucket": {
    "type": "s3",
    "configuration": {
      "name": "my-aws-bucket",
      "endpoint": null,
      "prefix": null,
      "region": "eu-west-1",
      "accessKeyId": "********************",
      "secretAccessKey": "******************************",
      "defaultStorageClass": null
    }
  }
}

Commands

In the following sections are described which commands can be executed with remote-files.

profiles

Manage connection profiles

list

List files in selected folder

download

Download selected file from source directory

upload

Upload selected file to target directory