diff --git a/README.md b/README.md index 77f8d45..a96ad20 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ S3 Terminal UI ## About -STU is the TUI application for AWS S3 written in Rust using [ratatui](https://github.com/ratatui-org/ratatui). +STU is the TUI explorer application for Amazon S3 (AWS S3) written in Rust using [ratatui](https://github.com/ratatui-org/ratatui). @@ -32,10 +32,22 @@ $ paru -S stu ### Binary -You can download binaries from [releases](https://github.com/lusingander/stu/releases) +You can download binaries from [releases](https://github.com/lusingander/stu/releases). ## Usage +After installation, run the following command: + +``` +$ stu +``` + +Basically, you can use it in [the same way as the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html). + +In other words, if the default profile settings exist or [the environment variables are set](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html), you do not need to specify any options. + +### Options + ``` STU - S3 Terminal UI @@ -51,11 +63,36 @@ Options: -V, --version Print version ``` -You can also use each environment variable in the same way as [when using the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html). +Here are some examples of how to run with options: -Detailed operations on each view can be displayed by pressing `?` key. +```sh +# Connect by specifying the profile +$ stu --profile foo-profile -Or refer to the `***-help.png` screenshots in the [./img directory](./img). +# Show only the specified bucket objects +$ stu --bucket bar-bucket + +# Connect to localstack, minio, etc. +$ stu --endpoint-url http://localhost:12345 + +# Connect by specifying environment variables +$ AWS_ACCESS_KEY_ID=abc AWS_SECRET_ACCESS_KEY=xyz stu +``` + +### Keybindings + +The basic key bindings are as follows: + +| Key | Description | +| -------------------- | ---------------------------------- | +| Ctrl-C | Quit app | +| Esc | Quit app / Close dialog | +| Enter | Confirm / Open selected item | +| Backspace | Go back to previous / Close dialog | +| j/k | Select item / Scroll | +| ? | Show help | + +Detailed operations on each view can be displayed by pressing `?` key. ### Config