s3-tool 0.3.6
S3 CLI Tool to execute basic commands
License: MIT
Requires Python: >=3.11,<4.0

# S3 Command Line Utility

### Credentials

First of all, you will need to have your credentials ready.
The following are needed (next to them are the names of the environmental variables associated to them):

- Endpoint `ENDPOINT`
- Access Key `ACCESS_KEY`
- Secret Access Key `SECRET_ACCESS_KEY`
- Bucket `BUCKET`
- OPTIONALLY: if you have an HTTP prefix for accessing keys over a web browser you can add it with the `HTTP_PREFIX` variable

In order to avoid having to introduce your credentials after every command execution it is possible to store them as environmental variables.
You can even do this temporarily setting a variables as `export ENDPOINT_URL=MyURL`. This way, your credentials will only be set for the current terminal.

### Operations

The following operations are possible:

- Listing all keys in a bucket
- Listing keys according to a prefix in a bucket
- Change key permissions to public-read
- Upload any number of keys. Is Multithreaded.
- Download any number of keys. Is Multithreaded.
- Delete keys. Is Multithreaded.

---

**Usage**:

```console
$ s3-tool [OPTIONS] COMMAND [ARGS]...
```

**Options**:

- `--install-completion`: Install completion for the current shell.
- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
- `--help`: Show this message and exit.

**Commands**:

- `change-permissions`: Takes any number of keys and changes their...
- `create-upload-list`: Writes a text file of all files in a folder...
- `delete-key`: USE WITH EXTREME CAUTION! Deletes a given key...
- `download`: Downloads a key or series of keys
- `list-keys`: Lists keys according to a given prefix
- `list-keys-v2`: Lists keys using S3 client. Allows for using a delimiter to limit the output to "subfolders"
- `upload`: Uploads a single file or multiple files.

## `s3-tool change-permissions`

Takes any number of keys and changes their permissions to public-read

**Usage**:

```console
$ s3-tool change-permissions [OPTIONS] ARGS...
```

**Options**:

- `--prefix-threads INTEGER`: Sets the amount of prefixes that should be queried in parallel.
- `--changer-threads INTEGER`: Sets the amount of threads used to change permissions for a given prefix.
- `-p, --permissions [private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control]`: Changes the keys permissions.
- `--help`: Show this message and exit.

## `s3-tool create-upload-list`

Writes a text file of all files in a folder with a given extension that
can be used together with the upload command to upload multiple files
at once

**Usage**:

```console
$ s3-tool create-upload-list [OPTIONS] FILES_PATH FILE_EXTENSION
```

**Options**:

- `--output-path TEXT`: Choose an output path. Else, the file will be written on the folder where the command is executed.
- `--help`: Show this message and exit.

## `s3-tool delete-key`

USE WITH EXTREME CAUTION! Deletes a given key or keys

**Usage**:

```console
$ s3-tool delete-key [OPTIONS]
```

**Options**:

- `-f, --files TEXT`: Keys to be deleted.
- `--prompt / --no-prompt`: Display a prompt to confirm deletion.
- `--threads INTEGER`: Set the amount of threads to delete keys in parallel. Disable the prompt if using this option.
- `--help`: Show this message and exit.

## `s3-tool download`

Downloads a key or series of keys

**Usage**:

```console
$ s3-tool download [OPTIONS] DOWNLOAD_PATH
```

**Options**:

- `-f, --files TEXT`: Either a file or files, or a text file containing paths to files separated by commas (,).
- `-r, --recursive TEXT`: Recursively downloads a objects after a / delimiter.
- `-t, --threads INTEGER`: Amount of threads used to download in parallel.
- `--help`: Show this message and exit.

## `s3-tool list-keys`

Lists keys according to a given prefix

**Usage**:

```console
$ s3-tool list-keys [OPTIONS]
```

**Options**:

- `-p, --prefix TEXT`: Prefix to look for keys.
- `-d, --delimiter TEXT`: A delimiter is a character you use to group keys.
- ` --max-keys, -mk INTEGER`: Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
- `-hp, --http-prefix`: Append HTTP URL Prefix to keys.
- `--all / --no-all`: USE WITH CAUTION! If True, will fetch every key in the Bucket.
- `-l, --limit INTEGER`: Limits the amount of keys returned.
- `-km, --key-methods [key|last_modified|size|owner]`
- `--help`: Show this message and exit.

## `s3-tool list-keys-v2`

Lists keys using the S3 client rather than Resource (used for thelist-keys command). Allows the usage of a delimiter to limit the output to "subfolders". Only operation not possible is the checking of ACL Grants.

**Usage**:

```console
$ s3-tool list-keys-v2 [OPTIONS]
```

**Options**:

* `-p, --prefix TEXT`: Prefix to look for keys  [default: source/]
* `-d, --delimiter TEXT`: A delimiter is a character you use to group keys.  [default: ]
* ` --max-keys, -mk INTEGER`: Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.  [default: 1000]
* `-hp, --http-prefix`: Append HTTP URL Prefix to keys  [default: False]
* `-km, --key-methods [key|last_modified|size|owner]`
* `--help`: Show this message and exit.

## `s3-tool upload`

Uploads a single file or multiple files. Files need to have their absolute path.
The last argument passed will be the upload path.
Optionally, one can choose the amount of threads that should be used.

**Usage**:

```console
$ s3-tool upload [OPTIONS] UPLOAD_PATH
```

**Options**:

- `-f, --files TEXT`: Chose either a file or files with absolute path.
- `-uff, --upload-from-file TEXT`: Upload using text file containing paths to files separated by commas (,).
- `--permissions TEXT`: Sets the permission for the uploaded file. Options are: 'private' | 'public-read' | 'public-read-write' | 'authenticated-read' | 'aws-exec-read' | 'bucket-owner-read' | 'bucket-owner-full-control'
- `--worker-threads INTEGER`: Amount of threads used to upload in parallel.
- `--help`: Show this message and exit.

## `s3-tool move-object`

    Moves objects from one location to another within the same bucket.

**Usage**:

```console
$ s3-tool move-object [OPTIONS] DESTINATION_PATH
```

**Options**:

- `-f, --files TEXT`: Choose one or more objects you wish to move.
- `--permissions TEXT`: Sets the permission for the copied object. Options are: 'private' | 'public-read' | 'public-read-write' | 'authenticated-read' | 'aws-exec-read' | 'bucket-owner-read' | 'bucket-owner-full-control'
- `-rn, --rename TEXT`: Choose new object name. Destination path will have no effect but has to be input just the same.
- `--threads INTEGER`: Amount of threads used to upload in parallel.
- `--help`: Show this message and exit.