aboutsummaryrefslogtreecommitdiff
path: root/doc/book
diff options
context:
space:
mode:
authorJonathan Davies <jpds@protonmail.com>2023-03-12 15:17:11 +0000
committerGitea <gitea@fake.local>2023-03-13 14:15:18 +0000
commitdc6be3983300ee3ee10f601cfc04a06563d86f48 (patch)
treed66d5ac4e7b91f6caf9b4fc155d82013b078d09b /doc/book
parent24e43f1aa0553686f9dace5d839b717cf634bf6c (diff)
downloadgarage-dc6be3983300ee3ee10f601cfc04a06563d86f48.tar.gz
garage-dc6be3983300ee3ee10f601cfc04a06563d86f48.zip
doc: cli.md: Added s5cmd example.
Diffstat (limited to 'doc/book')
-rw-r--r--doc/book/connect/cli.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/book/connect/cli.md b/doc/book/connect/cli.md
index 74e2d7ed..9b74bb5d 100644
--- a/doc/book/connect/cli.md
+++ b/doc/book/connect/cli.md
@@ -12,6 +12,7 @@ These tools are particularly suitable for debug, backups, website deployments or
| [AWS CLI](#aws-cli) | ✅ | Recommended |
| [rclone](#rclone) | ✅ | |
| [s3cmd](#s3cmd) | ✅ | |
+| [s5cmd](#s5cmd) | ✅ | |
| [(Cyber)duck](#cyberduck) | ✅ | |
| [WinSCP (libs3)](#winscp) | ✅ | CLI instructions only |
| [sftpgo](#sftpgo) | ✅ | |
@@ -178,6 +179,26 @@ s3cmd put /tmp/hello.txt s3://my-bucket/
s3cmd get s3://my-bucket/hello.txt hello.txt
```
+## `s5cmd`
+
+Configure a credentials file as follows:
+
+```bash
+export AWS_ACCESS_KEY_ID=GK...
+export AWS_SECRET_ACCESS_KEY=
+export AWS_DEFAULT_REGION='garage'
+export AWS_ENDPOINT='http://localhost:3900'
+```
+
+After adding these environment variables in your shell, `s5cmd` can be used
+with:
+
+```bash
+s5cmd --endpoint-url=$AWS_ENDPOINT ls
+```
+
+See its usage output for other commands available.
+
## Cyberduck & duck {#cyberduck}
Both Cyberduck (the GUI) and duck (the CLI) have a concept of "Connection Profiles" that contain some presets for a specific provider.