Twitter CLI

A command-line interface for Twitter, powered by the twitter gem. The CLI attempts to mimic the Twitter SMS commands wherever possible, however it offers more commands than are available via SMS.

History

The twitter gem previously contained a command-line interface, up until version 0.5.0, when it was removed. This project is offered as a sucessor to that effort, however it is a clean room implementation that contains none of John Nunemaker's original code.

Installation

gem install t

Continuous Integration

Usage Examples

Typing t help will give you a list of all the available commands. You can type t help TASK to get help for a specific command.

t help

Because Twitter requires OAuth for most of it's functionality, you'll need to register a new application at http://dev.twitter.com/apps/new. Once you create your application make sure to set the "Application Type" to "Read, Write and Access direct messages", otherwise you won't be able to post status updates or send direct messages via the CLI.

Once you have registered your application, you'll be assigned a consumer key and secret, which you can use to authorize your Twitter account.

t authorize --consumer-key YOUR_CONSUMER_KEY --consumer-secret YOUR_CONSUMER_SECRET

This will open a new browser window where you can authenticate to Twitter.

You can see a list of all the accounts you've authorized.

t accounts

You can easily switch between accounts.

t set default sferik

Incidentally, account information is stored in YAML format in ~/.trc.

Update your status

t update "I'm tweeting from the command line, powered by @gem."

Send a user a private message

t dm sferik "Want to get dinner together tonight?"

Update the location field in your profile

t set location San Francisco

Retrieve the latest Tweet posted by a user

t get sferik

Retrieve profile information for a user

t whois sferik

Get stats about a user

t stats sferik

Return a listing of users you might enjoy following

t suggest

Start following a user

t follow sferik

Stop following a user

t unfollow sferik

Retrieve the timeline of status updates from users you are following

t timeline

Retrieve the timeline of status updates that mention you

t mentions

Reply to a Tweet

t reply sferik Thanks

Send another user's latest Tweet to your followers

t retweet sferik

Mark a user's latest Tweet as one of your favorites

t favorite sferik

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

by using alpha, beta, and prerelease versions
by reporting bugs
by suggesting new features
by writing or editing documentation
by writing specifications
by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
by refactoring code
by closing issues
by reviewing patches
by financially (please send bitcoin donations to 1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L)

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issuse by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

Fork the project.
Create a topic branch.
Implement your feature or bug fix.
Add documentation for your feature or bug fix.
Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4.
Add specs for your feature or bug fix.
Run bundle exec rake spec. If your changes are not 100% covered, go back to step 6.
Commit and push your changes.
Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)

Supported Ruby Versions

This library aims to support and is tested against the following Ruby implementations:

Ruby 1.8.7
Ruby 1.9.1
Ruby 1.9.2
JRuby
Rubinius
Ruby Enterprise Edition

If something doesn't work on one of these interpreters, it should be considered a bug.

This library may inadvertently work (or seem to work) on other Ruby implementations, however support will only be provided for the versions listed above.

If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be personally responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.

dianakimball / t