https://github.com/matiaskorhonen/s3itch_client

Upload files to S3 via your own s3itch instance
https://github.com/matiaskorhonen/s3itch_client

unmaintained

Last synced: about 2 months ago
JSON representation

Upload files to S3 via your own s3itch instance

• Host: GitHub
• URL: https://github.com/matiaskorhonen/s3itch_client
• Owner: matiaskorhonen
• License: mit
• Created: 2012-09-29T13:14:10.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2014-03-28T10:32:05.000Z (almost 11 years ago)
• Last Synced: 2024-10-31T14:47:58.585Z (2 months ago)
• Topics: unmaintained
• Language: Ruby
• Size: 266 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# S3itch Client

Upload files to your [s3itch][s3itch] instance directly from the command line.

Each file is given a unique, unguessable filename based on the original filename. e.g. `kitten.jpeg` will be turned into something like: 

    kitten_def46901-9dfc-47ad-86b5-c6831d65d9ed.jpeg

## Installation & Configuration

Install it from RubyGems:

    $ gem install s3itch-cli

For your own convenience, create the `~/.s3itch.yml` file with the following contents:

    ---

    url: http://YOUR-S3ITCH-INSTANCE.herokuapp.com

    username: S3ITCH_USERNAME

    password: YOUR_PASSWORD

    parameterize: true

    use_timestamp_suffix: true

## Usage

If you haven't defined your [s3itch][s3itch] URL, username, and password in `~/.s3itch.yml`, you'll have to do so via the CLI options.

    Usage: s3itch [options] 

        -u, --url [URL]                  Set the s3itch host URL

        -n, --user [USERNAME]            Set the s3itch username

        -p, --password [PASSWORD]        Set the s3itch password

        -h, --help                       Show this message

            --version                    Show version

CLI arguments will always override any options set in the config file.

If you've configured you `~/.s3itch.yml` correctly, uploading an image is as simple as:

    s3itch kittens.jpeg

## Tests [![Build Status](https://secure.travis-ci.org/k33l0r/s3itch_client.png)](http://travis-ci.org/k33l0r/s3itch_client)

S3itch Client is tested with RSpec:

    bundle exec rake spec

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Check that the test suite passes and add new specs if necessary

4. Commit your changes (`git commit -am 'Add some feature'`)

5. Push to the branch (`git push origin my-new-feature`)

6. Create new Pull Request

[s3itch]: https://github.com/roidrage/s3itch