Skip to content

Latest commit

聽

History

History
102 lines (64 loc) 路 2.25 KB

README.md

File metadata and controls

102 lines (64 loc) 路 2.25 KB
Raw

STU

Crate Status

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.

The values that can be set are as follows:

  • download_dir: string - Directory to save when downloading objects (default: $STU_ROOT_DIR/download)

Features / Screenshots

Bucket list

  • Show list of buckets

Object list

  • Show list of objects in a hierarchy

Object detail

  • Show object details
  • Download object
  • Preview object (text file only)
  • Copy resource name to clipboard

License

MIT