lusingander / stu

TUI (Terminal/Text UI) application for AWS S3 🪣

STU

S3 Terminal UI

About

STU is the TUI application for AWS S3 written in Rust using ratatui.

Installation

Cargo

$ cargo install stu

Homebrew (macOS)

$ brew install lusingander/tap/stu

AUR (Arch Linux)

$ paru -S stu

Binary

You can download binaries from releases

Usage

STU - S3 Terminal UI

Usage: stu [OPTIONS]

Options:
  -r, --region <REGION>     AWS region
  -e, --endpoint-url <URL>  AWS endpoint url
  -p, --profile <NAME>      AWS profile name
  -b, --bucket <NAME>       Target bucket name
      --debug               Output debug logs
  -h, --help                Print help
  -V, --version             Print version

You can also use each environment variable in the same way as when using the AWS CLI.

Detailed operations on each view can be displayed by pressing ? key.

Or refer to the ***-help.png screenshots in the ./img directory.

Config

Config is loaded from $STU_ROOT_DIR/config.toml.

• If STU_ROOT_DIR environment variable is not set, ~/.stu is used by default.
• If the file does not exist, it will be created automatically at startup.
• If no value is set, the default value will be set.

The values that can be set are as follows:

• download_dir: string - Directory to save when downloading objects (default: $STU_ROOT_DIR/download)
• preview.highlight: bool - Whether syntax highlighting is enabled in preview (default: false)

Features / Screenshots

Bucket list

• Show list of buckets
  • filter/sort items

Object list

• Show list of objects in a hierarchy
  • filter/sort items

Object detail

• Show object details
• Show object versions
• Download object
• Preview object (text file only)
  • syntax highlighting (by syntect)
• Copy resource name to clipboard

Troubleshooting

• If you cannot connect to AWS S3, first check whether you can connect using the AWS CLI with the same settings.
• By running with the --debug flag, logs will be output to $STU_ROOT_DIR/debug.log.
  • Currently, application events and AWS SDK logs are output.
  • Pressing F12 while the application is running will dump the application state to the log.
• When reporting a problem, please include the information like the following.
  • Application version
  • Operating system and version
  • Terminal you are using
  • Steps to reproduce the issue
  • Relevant log files or error messages

License

MIT