Edit directly a file on Amazon S3 in CLI
Clone or download

README.md

s3-edit

Edit directly a file on Amazon S3 in CLI.

GitHub release CircleCI branch Go Documentation MIT license

Installation

Use go get

$ go get -u github.com/tsub/s3-edit

Install with Homebrew

For only macOS

$ brew install tsub/s3-edit/s3-edit

Get binary from GitHub releases

Download binary from https://github.com/tsub/s3-edit/releases

Requirements

  • AWS credentials
  • Upload files to S3 in advance

For examples, use aws-cli

$ aws configure --profile myaccount
$ export AWS_PROFILE=myaccount

Other methods,

$ export AWS_ACCESS_KEY_ID=xxxx
$ export AWS_SECRET_ACCESS_KEY=xxxx
$ export AWS_REGION=ap-northeast-1

Usage

Upload the file to S3 in advance.

$ echo "This is a test file." > myfile.txt
$ aws s3 cp test.txt s3://mybucket/myfile.txt

To directly edit a file on S3, use edit subcommand.

$ s3-edit edit s3://mybucket/myfile.txt

Then, open a file with the default editor specified by $EDITOR.

https://gyazo.com/96c9225da700f91e7b44c04f439fdd23

When you close the editor after edit, a file is automatically re-uploaded to S3.

$ aws s3 cp s3://mybucket/myfile.txt -
This is a test file.
Edited with s3-edit.

Future

  • Provide the Homebrew formula
  • Add server-side encryption option

Development

Requirements

  • Golang >= 1.11

How to setup

$ git clone git@github.com:tsub/s3-edit.git
$ export GO111MODULE=on