whatisgithub

What is hermes-s3-plugin?

lagoon-labs/hermes-s3-plugin — explained in plain English

Analysis updated 2026-05-18

0PythonAudience · ops devopsComplexity · 2/5LicenseSetup · moderate

In one sentence

A Hermes plugin that backs up files to any S3 compatible cloud storage, with push, pull, list, and remove commands.

Mindmap

mindmap
  root((repo))
    What it does
      Backs up files to S3
      Push pull list remove
      Works with any provider
    Tech stack
      Python
      boto3
      PyYAML
    Use cases
      Automate daily backups
      Restore files from storage
      Script backup workflows
    Audience
      Developers
      Ops teams
    Setup
      hermes plugins install
      Set env variables
      Requires Python 3.10 plus

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Set up an automatic daily backup rule that pushes a project folder to cloud storage.

USE CASE 2

Restore a previously backed up folder by pulling it down from your storage bucket.

USE CASE 3

List what is currently stored under a given path before deciding to delete anything.

USE CASE 4

Script backups and restores in a pipeline using the plugin's JSON output.

What is it built with?

Pythonboto3PyYAML

How does it compare?

lagoon-labs/hermes-s3-plugin0xallam/my-recipe0xhassaan/nn-from-scratch
Stars00
LanguagePythonPythonPython
Last pushed2022-11-22
MaintenanceDormant
Setup difficultymoderatemoderatemoderate
Complexity2/52/54/5
Audienceops devopsgeneraldeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Requires Python 3.10+, an existing Hermes install, and S3-compatible storage credentials.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

So what is it?

This is a plugin for a tool called Hermes that adds the ability to back up files and folders to any S3 compatible cloud storage service, such as AWS S3, Cloudflare R2, or MinIO. Once installed, it lets you push files up to storage, pull them back down, list what is stored, and remove objects you no longer need. Most people would install it directly through Hermes with a single install command, or by copying the plugin folder into their Hermes plugins directory. Setup involves creating environment variables for your storage endpoint, region, bucket name, and access credentials, which should be kept in a private environment file and never committed to source control or placed directly in commands. Once configured, everyday use is a small set of commands: push a local file or folder up to a remote location, pull a remote prefix back down to your machine, list what exists under a given path, or delete a specific object, which requires an extra confirmation flag as a safety check. Uploading skips files that already exist unless you explicitly ask it to overwrite them. You can also define named, reusable backup rules in a YAML file, so a command like a daily backup can be run repeatedly without retyping the source and destination each time, and these rules support placeholders for the current date. Every command outputs a simple JSON result, which makes it easy to use from scripts. The plugin requires Python 3.10 or newer along with the boto3 and PyYAML libraries, and it is released under the MIT license.

Copy-paste prompts

Prompt 1
Install this Hermes S3 plugin and set up the environment variables for Cloudflare R2.
Prompt 2
Show me how to define a named backup rule with a date placeholder for a daily backup.
Prompt 3
Explain the difference between hermes s3 push and hermes s3 push --force.
Prompt 4
Write a script that uses this plugin's JSON output to check whether a backup succeeded.

Frequently asked questions

What is hermes-s3-plugin?

A Hermes plugin that backs up files to any S3 compatible cloud storage, with push, pull, list, and remove commands.

What language is hermes-s3-plugin written in?

Mainly Python. The stack also includes Python, boto3, PyYAML.

What license does hermes-s3-plugin use?

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

How hard is hermes-s3-plugin to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is hermes-s3-plugin for?

Mainly ops devops.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.