-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
53 lines (38 loc) · 1.5 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
// +build !test
/*
Twivility is a service that track a specific Twitter account's feeds, and
provides a web interface with some simple analysis.
Important! Any of the three commands require all four environment variables
to be set. See "Environment Variables".
Security note: all four environment variables have corresponding command line
flags (for instance, you can use `--consumer-key=yadda` instead of setting
the environment variable TWITTER_CONSUMER_KEY). HOWEVER, that is generally
a bad idea since the command line can be viewed with the `ps` command.
Usage
twivility [flags] cmd
Commands
service
Run the Twivility service (by default serving at Orwellian port 8484).
Includes the HTML client/site (served at "/"). The service will
occasionally query Twitter for new tweets.
update
Updates the local store of stored tweets. Note that no synchronization
will be attempted with a running copy of the service, so you should
make sure to run this when no other instance of twivility is active.
dump
Dump all tweets stored to stdout as a JSON object.
json
A synonym for the "dump" command
Flags
-host <address binding string>
The default value is "127.0.0.1:8484". Note that this flag only has an
effect when using the "service" command
Environment Variables
TWITTER_CONSUMER_KEY
TWITTER_CONSUMER_SECRET
TWITTER_ACCESS_TOKEN
TWITTER_ACCESS_SECRET
These values can be found at
https://dev.twitter.com/oauth/overview/application-owner-access-tokens
*/
package main