Skip to content
This repository
Newer
Older
100644 266 lines (167 sloc) 8.694 kb
48dbd537 »
2011-12-16 Update README
1 # Twitter CLI [![Build Status](https://secure.travis-ci.org/sferik/t.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/sferik/t.png?travis)][gemnasium]
d9ff8746 »
2012-03-29 Update description
2 ### A command-line power tool for Twitter.
3
4 The CLI attempts to mimic the [Twitter SMS commands][sms] wherever possible,
5 however it offers many more commands than are available via SMS.
8f54d11c »
2011-11-22 Initial commit
6
48dbd537 »
2011-12-16 Update README
7 [travis]: http://travis-ci.org/sferik/t
8 [gemnasium]: https://gemnasium.com/sferik/t
8f54d11c »
2011-11-22 Initial commit
9 [gem]: https://rubygems.org/gems/twitter
10 [sms]: https://support.twitter.com/articles/14020-twitter-sms-command
11
daf46479 »
2011-11-23 Move text outside anchors
12 ## <a name="installation"></a>Installation
8f54d11c »
2011-11-22 Initial commit
13 gem install t
14
4e403428 »
2011-12-01 Add dependency status [ci skip]
15
48dbd537 »
2011-12-16 Update README
16 ## <a name="configuration"></a>Configuration
8f54d11c »
2011-11-22 Initial commit
17
fe7554f4 » dianakimball
2011-11-23 Fix typos
18 Because Twitter requires OAuth for most of its functionality, you'll need to
8f54d11c »
2011-11-22 Initial commit
19 register a new application at <http://dev.twitter.com/apps/new>. Once you
20 create your application make sure to set the "Application Type" to "Read, Write
21 and Access direct messages", otherwise you won't be able to post status updates
22 or send direct messages via the CLI.
23
bfcef3bf »
2011-12-02 Clarify text
24 Once you have registered your application, you'll be given a consumer key and
25 secret, which you can use to authorize your Twitter account.
8f54d11c »
2011-11-22 Initial commit
26
b550d2ab »
2011-12-06 Use dashes instead of underscores in documentation [ci skip]
27 t authorize --consumer-key YOUR_CONSUMER_KEY --consumer-secret YOUR_CONSUMER_SECRET
8f54d11c »
2011-11-22 Initial commit
28
bfcef3bf »
2011-12-02 Clarify text
29 This will open a new browser window where you can authenticate to Twitter and
48dbd537 »
2011-12-16 Update README
30 then enter the returned PIN back into the terminal. Assuming that works,
31 you'll be authorized to use the CLI.
8f54d11c »
2011-11-22 Initial commit
32
33 You can see a list of all the accounts you've authorized.
34
35 t accounts
36
bfcef3bf »
2011-12-02 Clarify text
37 sferik
38 UDfNTpOz5ZDG4a6w7dIWj
39 uuP7Xbl2mEfGMiDu1uIyFN
40 gem
41 thG9EfWoADtIr6NjbL9ON (default)
8f54d11c »
2011-11-22 Initial commit
42
bfcef3bf »
2011-12-02 Clarify text
43 Notice that one account is marked as the default. To change the default use the
44 `set` subcommand, passing either just the username, if it's unambiguous, or the
48dbd537 »
2011-12-16 Update README
45 username and consumer key pair, like so:
8f54d11c »
2011-11-22 Initial commit
46
bfcef3bf »
2011-12-02 Clarify text
47 t set default sferik thG9EfWoADtIr6NjbL9ON
48
49 Account information is stored in the YAML-formatted file `~/.trc`.
8f54d11c »
2011-11-22 Initial commit
50
48dbd537 »
2011-12-16 Update README
51 ## <a name="examples"></a>Usage Examples
52
53 Typing `t help` will give you a list of all the available commands. You can
54 type `t help TASK` to get help for a specific command.
55
56 t help
57
daf46479 »
2011-11-23 Move text outside anchors
58 ### <a name="update"></a>Update your status
8f54d11c »
2011-11-22 Initial commit
59
e8f509a1 »
2011-12-09 More interesting example tweet [ci skip]
60 t update "I'm tweeting from the command line. Isn't that special?"
8f54d11c »
2011-11-22 Initial commit
61
48dbd537 »
2011-12-16 Update README
62 ### <a name="dm"></a>Send a direct message
8f54d11c »
2011-11-22 Initial commit
63
48dbd537 »
2011-12-16 Update README
64 t dm sferik "Want to get dinner tonight?"
8f54d11c »
2011-11-22 Initial commit
65
daf46479 »
2011-11-23 Move text outside anchors
66 ### <a name="location"></a>Update the location field in your profile
8f54d11c »
2011-11-22 Initial commit
67
c0bee586 »
2011-12-11 Update README
68 t set location "San Francisco"
8f54d11c »
2011-11-22 Initial commit
69
daf46479 »
2011-11-23 Move text outside anchors
70 ### <a name="whois"></a>Retrieve profile information for a user
8f54d11c »
2011-11-22 Initial commit
71
72 t whois sferik
73
48dbd537 »
2011-12-16 Update README
74 ### <a name="stats"></a>Retrieve stats about a user
8f54d11c »
2011-11-22 Initial commit
75
76 t stats sferik
77
c0bee586 »
2011-12-11 Update README
78 ### <a name="suggest"></a>Return a user you might enjoy following
8f54d11c »
2011-11-22 Initial commit
79
80 t suggest
81
48dbd537 »
2011-12-16 Update README
82 ### <a name="follow-users"></a>Start following users
8f54d11c »
2011-11-22 Initial commit
83
a8db7a31 »
2011-12-16 Add methods for bulk list addition
84 t follow users sferik gem
8f54d11c »
2011-11-22 Initial commit
85
8ccd31c3 »
2011-12-26 Flatten namespace by one level
86 ### <a name="follow-followers"></a>Follow all followers (i.e. follow back)
5511c87f »
2011-12-12 Add follow/unfollow all commands [ci skip]
87
8ccd31c3 »
2011-12-26 Flatten namespace by one level
88 t follow followers
5511c87f »
2011-12-12 Add follow/unfollow all commands [ci skip]
89
48dbd537 »
2011-12-16 Update README
90 ### <a name="unfollow-users"></a>Stop following users
a8db7a31 »
2011-12-16 Add methods for bulk list addition
91
92 t unfollow users sferik gem
93
8ccd31c3 »
2011-12-26 Flatten namespace by one level
94 ### <a name="unfollow-nonfollowers"></a>Unfollow all non-followers
5511c87f »
2011-12-12 Add follow/unfollow all commands [ci skip]
95
8ccd31c3 »
2011-12-26 Flatten namespace by one level
96 t unfollow nonfollowers
5511c87f »
2011-12-12 Add follow/unfollow all commands [ci skip]
97
48dbd537 »
2011-12-16 Update README
98 ### <a name="list-create"></a>Create a list
99
100 t list create presidents
101
102 ### <a name="list-add-followers"></a>Add users to a list
103
104 t list add users presidents BarackObama Jasonfinn
105
106 ### <a name="list-add-friends"></a>Add all friends to a list
107
8ccd31c3 »
2011-12-26 Flatten namespace by one level
108 t list add friends presidents
48dbd537 »
2011-12-16 Update README
109
110 ### <a name="list-add-followers"></a>Add all followers to a list
111
8ccd31c3 »
2011-12-26 Flatten namespace by one level
112 t list add followers presidents
48dbd537 »
2011-12-16 Update README
113
114 ### <a name="list-add-followers"></a>Add all members of one list to another
115
8ccd31c3 »
2011-12-26 Flatten namespace by one level
116 t list add listed democrats presidents
48dbd537 »
2011-12-16 Update README
117
118 ### <a name="follow-all-listed"></a>Follow all members of a list
119
8ccd31c3 »
2011-12-26 Flatten namespace by one level
120 t follow listed presidents
48dbd537 »
2011-12-16 Update README
121
122 ### <a name="unfollow-all-listed"></a>Unfollow all members of a list
a8db7a31 »
2011-12-16 Add methods for bulk list addition
123
8ccd31c3 »
2011-12-26 Flatten namespace by one level
124 t unfollow listed presidents
a8db7a31 »
2011-12-16 Add methods for bulk list addition
125
48dbd537 »
2011-12-16 Update README
126 ### <a name="list-timeline"></a>Retrieve the timeline of status updates from a list
8f54d11c »
2011-11-22 Initial commit
127
48dbd537 »
2011-12-16 Update README
128 t list timeline presidents
8f54d11c »
2011-11-22 Initial commit
129
48ace99a »
2011-12-26 Unify get and timeline methods
130 ### <a name="timeline"></a>Retrieve the timeline of status updates posted by you and the users you follow
131
132 t timeline
133
134 ### <a name="timeline-user"></a>Retrieve the timeline of status updates posted by a user
135
136 t timeline sferik
137
daf46479 »
2011-11-23 Move text outside anchors
138 ### <a name="mentions"></a>Retrieve the timeline of status updates that mention you
8f54d11c »
2011-11-22 Initial commit
139
140 t mentions
141
c0bee586 »
2011-12-11 Update README
142 ### <a name="favorites"></a>Retrieve the timeline of status updates that you favorited
143
144 t favorites
145
daf46479 »
2011-11-23 Move text outside anchors
146 ### <a name="reply"></a>Reply to a Tweet
8f54d11c »
2011-11-22 Initial commit
147
bc8134b9 »
2011-12-04 Add cucumber
148 t reply sferik "Thanks Erik"
8f54d11c »
2011-11-22 Initial commit
149
daf46479 »
2011-11-23 Move text outside anchors
150 ### <a name="retweet"></a>Send another user's latest Tweet to your followers
8f54d11c »
2011-11-22 Initial commit
151
152 t retweet sferik
153
daf46479 »
2011-11-23 Move text outside anchors
154 ### <a name="favorite"></a>Mark a user's latest Tweet as one of your favorites
8f54d11c »
2011-11-22 Initial commit
155
156 t favorite sferik
157
8fd107bb »
2011-12-26 Document search methods
158 ### <a name="search-all"></a>Retrieve the 20 most recent Tweets that match a specified query
159
25105145 »
2012-03-28 Add new methods to README
160 t search all "query"
161
162 ### <a name="search-retweets"></a>Returns Tweets you've favorited that mach a specified query
163
164 t search favorites "query"
165
166 ### <a name="search-mentions"></a>Returns Tweets mentioning you that mach a specified query
167
168 t search mentions "query"
169
170 ### <a name="search-retweets"></a>Returns Tweets you've retweeted that mach a specified query
171
172 t search retweets "query"
8fd107bb »
2011-12-26 Document search methods
173
174 ### <a name="search-timeline"></a>Retrieve Tweets in your timeline that match a specified query
175
25105145 »
2012-03-28 Add new methods to README
176 t search timeline "query"
8fd107bb »
2011-12-26 Document search methods
177
178 ### <a name="search-user"></a>Retrieve Tweets in a user's timeline that match a specified query
179
25105145 »
2012-03-28 Add new methods to README
180 t search user sferik "query"
8fd107bb »
2011-12-26 Document search methods
181
48dbd537 »
2011-12-16 Update README
182 ## <a name="history"></a>History
183 ![History](http://twitter.rubyforge.org/images/terminal_output.png "History")
184
185 The [twitter gem][gem] previously contained a command-line interface, up until
186 version 0.5.0, when it was [removed][]. This project is offered as a sucessor
187 to that effort, however it is a clean room implementation that contains none of
188 John Nunemaker's original code.
189
190 [removed]: https://github.com/jnunemaker/twitter/commit/dd2445e3e2c97f38b28a3f32ea902536b3897adf
191
daf46479 »
2011-11-23 Move text outside anchors
192 ## <a name="contributing"></a>Contributing
8f54d11c »
2011-11-22 Initial commit
193 In the spirit of [free software][fsf], **everyone** is encouraged to help
194 improve this project.
195
196 [fsf]: http://www.fsf.org/licensing/essays/free-sw.html
197
198 Here are some ways *you* can contribute:
199
200 * by using alpha, beta, and prerelease versions
201 * by reporting bugs
202 * by suggesting new features
203 * by writing or editing documentation
204 * by writing specifications
205 * by writing code (**no patch is too small**: fix typos, add comments, clean up
206 inconsistent whitespace)
207 * by refactoring code
208 * by closing [issues][]
209 * by reviewing patches
210
211 [issues]: https://github.com/sferik/t/issues
212
daf46479 »
2011-11-23 Move text outside anchors
213 ## <a name="issues"></a>Submitting an Issue
8f54d11c »
2011-11-22 Initial commit
214 We use the [GitHub issue tracker][issues] to track bugs and features. Before
215 submitting a bug report or feature request, check to make sure it hasn't
fe7554f4 » dianakimball
2011-11-23 Fix typos
216 already been submitted. You can indicate support for an existing issue by
4e403428 »
2011-12-01 Add dependency status [ci skip]
217 voting it up. When submitting a bug report, please include a [Gist][] that
218 includes a stack trace and any details that may be necessary to reproduce the
219 bug, including your gem version, Ruby version, and operating system. Ideally, a
220 bug report should include a pull request with failing specs.
221
222 [gist]: https://gist.github.com/
8f54d11c »
2011-11-22 Initial commit
223
daf46479 »
2011-11-23 Move text outside anchors
224 ## <a name="pulls"></a>Submitting a Pull Request
8f54d11c »
2011-11-22 Initial commit
225 1. Fork the project.
226 2. Create a topic branch.
227 3. Implement your feature or bug fix.
48dbd537 »
2011-12-16 Update README
228 4. Add specs for your feature or bug fix.
229 5. Run `bundle exec rake spec`. If your changes are not 100% covered, go back
230 to step 4.
231 6. Commit and push your changes.
232 7. Submit a pull request. Please do not include changes to the gemspec,
8f54d11c »
2011-11-22 Initial commit
233 version, or history file. (If you want to create your own version for some
234 reason, please do so in a separate commit.)
235
daf46479 »
2011-11-23 Move text outside anchors
236 ## <a name="versions"></a>Supported Ruby Versions
498dba2f »
2011-12-03 Make status images more consistent [ci skip]
237 This library aims to support and is [tested against][travis] the following Ruby
8f54d11c »
2011-11-22 Initial commit
238 implementations:
239
240 * Ruby 1.8.7
241 * Ruby 1.9.2
4e403428 »
2011-12-01 Add dependency status [ci skip]
242 * Ruby 1.9.3
4abeef90 »
2011-12-05 Add support for alternative Ruby implementations
243 * [JRuby][]
244 * [Rubinius][]
245
246 [jruby]: http://www.jruby.org/
247 [rubinius]: http://rubini.us/
8f54d11c »
2011-11-22 Initial commit
248
249 If something doesn't work on one of these interpreters, it should be considered
250 a bug.
251
252 This library may inadvertently work (or seem to work) on other Ruby
253 implementations, however support will only be provided for the versions listed
254 above.
255
256 If you would like this library to support another Ruby version, you may
257 volunteer to be a maintainer. Being a maintainer entails making sure all tests
258 run and pass on that implementation. When something breaks on your
259 implementation, you will be personally responsible for providing patches in a
260 timely fashion. If critical issues for a particular implementation exist at the
261 time of a major release, support for that Ruby version may be dropped.
262
daf46479 »
2011-11-23 Move text outside anchors
263 ## <a name="copyright"></a>Copyright
8f54d11c »
2011-11-22 Initial commit
264 Copyright (c) 2011 Erik Michaels-Ober. See [LICENSE][] for details.
265
266 [license]: https://github.com/sferik/t/blob/master/LICENSE.md
Something went wrong with that request. Please try again.