drivel/Readme.md

106 lines
2.3 KiB
Markdown
Raw Normal View History

2019-01-01 19:35:22 +01:00
drivel
========
2020-09-20 08:38:51 +02:00
drivel is a Twitter command line interface.
2019-01-01 19:35:22 +01:00
You can find releases on [releases.gutmet.org](https://releases.gutmet.org) or
build it yourself.
build
-----
2020-09-16 11:24:08 +02:00
Checkout the repository and compile with
2019-01-01 19:35:22 +01:00
```
2020-10-15 21:34:59 +02:00
go build -o drivel
2019-01-01 19:35:22 +01:00
```
usage
-----
To get up to the last 200 tweets of your home timeline:
2020-09-17 21:44:57 +02:00
```
drivel home
```
To get up to the last 200 tweets of your mention timeline:
```
drivel mentions
```
To get up to the last 200 tweets of @USER:
2020-09-20 20:37:12 +02:00
```
2020-10-21 12:39:47 +02:00
drivel timeline USER
2020-09-20 20:37:12 +02:00
```
2020-09-18 09:18:32 +02:00
To like a tweet with a specific ID:
```
drivel like TWEET_ID
```
2020-09-19 22:31:09 +02:00
To retweet a tweet with a specific ID:
```
drivel retweet TWEET_ID
```
To lookup tweets with specific IDs:
```
drivel lookup TWEET_ID1 [TWEET_ID2 TWEET_ID3 ...]
```
2020-09-27 11:46:52 +02:00
To wipe your timeline and likes (keepDays defaults to 10, can only reach back as far as the result of the timeline):
```
2020-10-21 12:39:47 +02:00
drivel wipe
2020-09-27 11:46:52 +02:00
```
2020-09-27 11:46:52 +02:00
To update your status with optional media upload:
2019-01-01 19:35:22 +01:00
```
drivel status STATUS [FILE1 FILE2 ...]
2019-01-01 19:35:22 +01:00
```
2020-09-19 22:31:09 +02:00
To reply to a tweet with a specific ID:
2020-09-17 21:30:51 +02:00
```
drivel reply TWEET_ID MESSAGE [FILE1 FILE2 ...]
2020-09-17 21:30:51 +02:00
```
2020-09-19 22:31:09 +02:00
To quote a tweet with a specific ID:
2020-09-19 22:12:59 +02:00
```
drivel quote TWEET_ID MESSAGE [FILE1 FILE2 ...]
2020-09-19 22:12:59 +02:00
```
2020-09-17 21:30:51 +02:00
2020-09-18 23:22:42 +02:00
with any number of files, as long as they are .jpg, .png, .gif or .mp4 and smaller than 50 MB each. On first use, drivel will ask you to go to [https://apps.twitter.com/app/new](https://apps.twitter.com/app/new), register a new app and create an access token. Those values will be stored in HOME/.drivel/ for later use.
2019-01-01 19:35:22 +01:00
drivel will automatically split large status messages and multiple files into separate tweets belonging to the same thread.
2020-10-23 19:21:46 +02:00
The results of the 'home' and 'mentions' commands can be filtered to only include certain user names. Create text files 'AllowlistHome' and 'AllowlistMentions' in HOME/.drivel and list allowed users line by line.
2020-09-16 11:24:08 +02:00
Each command (other than wipe) can use a go text template to format the printed results - pass a file name to '--template'. The template is executed with a slice of []Status. See types.go for available data fields and example.template for a minimalist example.
2020-10-21 12:39:47 +02:00
For more options consult 'drivel help COMMAND'.
2020-09-16 11:24:08 +02:00
final note
----------
drivel does not sanitize/validate user input for now.
final final note
----------------
2020-09-19 22:31:09 +02:00
You can buy me a beer [here](http://paypal.me/AlexanderWeinhold).