S3CL(1)

📦
version 0.992 · 5 versions
, in epel 9

💅 S3CL(1) — the s3cl girlie's guide to Amazon S3 🌸

okay so bestie, welcome to S3CL(1), aka the s3cl command line situation. section 1 of the manual, user-contributed Perl documentation, and honestly? iconic. 💖

✨ NAME ✨

s3cl — literally just a command line for Amazon s3 cloud storage. that's the whole vibe. 🦋

🎀 VERSION 🎀

version 0.992 — yes she has a version number, respect her.

🌈 SYNOPSIS 🌈

the basic shape of things, no cap:

s3cl command [options]

and here's the whole lineup of commands, serving looks:

  s3cl buckets
  s3cl mkbucket --bucket some_bucket_name --jurisdiction [EU|US]
  s3cl ls <bucket>:[prefix]
  s3cl cp <bucket>:<key> /path/[filename]
  s3cl sync <bucket>:[prefix] /path/
  s3cl sync_up [--acl_short=public-read] <bucket>:[prefix] /path/
  s3cl rm <bucket>:<key>

and the options, short but sweet:

   Options:
     -help            brief help message
     -man             full documentation
🚨 real talk: We take NO responsibility for the costs incured through using this script. (yes, "incured" — we're quoting her exactly, she's perfect 💅). like, your bill is your business, bestie.

to run this script you need a pair of environment variables set, periodt:

   AWS_ACCESS_KEY_ID
   AWS_ACCESS_KEY_SECRET

no keys, no vibes. 🔑

💜 DESCRIPTION 💜

okay so what does this program actually do? it gives you a command line interface to Amazon's s3 storage service. that's the main character energy right there. 👑

but listen — it does not limit the number of requests (which may cost you more money than if you did it a different way!) and each request costs Money (although some costs from EC2 may be $0.0, check the latest from the Amazon costs page). and yeah — we take NO responsibility for your bill. 😭 fr fr, your wallet, your problem.

🌸 AUTHOR 🌸

Branislav Zahradník <barney@cpan.org> — thank her for her service 🫶

This software is copyright (c) 2025 by Amazon Digital Services, Leon Brocard, Brad Fitzpatrick, Pedro Figueiredo, Rusty Conover, Branislav Zahradník.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay, open source legend. 🌈

🔥 COMMANDS 🔥

🪣 buckets

s3cl buckets

List all buckets for this account. that's it, that's the whole thing. bucket inventory, served fresh. ✨

🧚 mkbucket

s3cl mkbucket --bucket sombucketname [--jurisdiction [EU|US]]

Create a new bucket, optionally specifying what jurisdiction it should be created in. (note: the synopsis says sombucketname, not some_bucket_name — we don't make the rules, we just respect them 💀)

🦋 ls

s3cl ls <bucket>:[prefix]

List contents of a bucket. the optional prefix can be partial, in which case all keys matching this as the start of the key name will be returned. if no prefix is supplied, all keys of the bucket will be returned. iykyk — prefix = filter, no prefix = the whole fit. 💅

🎀 cp

s3cl cp <bucket>:<key> target_file
s3cl cp <bucket>:<key> target_directory

Copy a single key from the bucket to the target file, or into the target_directory. one key, one destination, no drama. 🫶

🍓 sync

s3cl sync <bucket>:[prefix] target_dir

Downloads all files matching the prefix into a directory structure replicating that of the prefix and all 'sub-directories'. it will download ALL files — even if already on your local disk:

http://www.amazon.com/gp/browse.html?node=16427261
  #  Data transfer "in" and "out" refers to transfer into and out
  #  of Amazon S3.  Data transferred between Amazon EC2 and
  #  Amazon S3, is free of charge (i.e., $0.00 per GB), except
  #  data transferred between Amazon EC2 and Amazon S3-Europe,
  #  which will be charged at regular rates.

so like, free-ish, except when it's not. check the fine print, bestie. 💸

🧵 sync_up

s3cl sync_up [--acl_short=public-read] <bucket>:[prefix] /path/

Upload all the files below /path/ to S3, with an optional prefix at the start of the key name. the existing S3 files and meta data are fetched from S3 and the md5 (etag) is compaired to what is on the local disk, files are not upload if the content has not changed. (yes, "compaired" and "not upload" — we quote the queen verbatim 👑)

Use --acl_short to set access control, options from Net::Amazon::S3::Bucket#set_acl — this is only applied when the file is uploaded. 🎀

Each file's content-type is worked out using MIME::Types. if this does not match, 'text/plain' is used for ASCII text files, otherwise a warning is issued and the file is NOT uploaded. no content-type, no entry. 🙈

⚠️ Currently this does NOT remove old files from S3, and if there is any change to a file then the entire file will be reuploaded. annoying? yes. facts? also yes.

💀 rm

s3cl rm <bucket>:<key>

Remove a key (file) from the bucket. removing a non-existent file is not classed as an error. but once removed the key (file) can not be restored — so use with care! 🚨 like genuinely, be careful, there's no undo here.

👑 ABOUT 👑

This module contains code modified from Amazon that contains the following notice (which is also applicicable to this code) — spelling again preserved, we love her:

  #  This software code is made available "AS IS" without
  #  warranties of any kind.  You may copy, display, modify and
  #  redistribute the software code either by itself or as incorporated
  #  into your code; provided that you do not remove any proprietary
  #  notices.  Your use of this software code is at your own risk and
  #  you waive any claim against Amazon Digital Services, Inc. or its
  #  affiliates with respect to your use of this software code.
  #  (c) 2006 Amazon Digital Services, Inc. or its affiliates.

🦋 AUTHOR (again, she gets two sections) 🦋

Leo Lapworth <LLAP@cuckoo.org> — Part of the HinuHinu project. 💖

okay that's the whole page bestie!! and for the cute little sign-off at the bottom, the original footer was serving: perl v5.32.1, dated 2025-11-24, tagged S3CL(1). so there you go — go forth, sync responsibly, and don't blame us for your AWS bill 💅✨🎀

📦 where this page comes from