Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aksiksi/histweet
A CLI tool that simplifies managing your Twitter history.
https://github.com/aksiksi/histweet
Last synced: 6 days ago
JSON representation
A CLI tool that simplifies managing your Twitter history.
- Host: GitHub
- URL: https://github.com/aksiksi/histweet
- Owner: aksiksi
- Created: 2020-06-28T19:39:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-12T03:56:47.000Z (almost 4 years ago)
- Last Synced: 2023-03-16T23:15:29.319Z (over 1 year ago)
- Language: Go
- Size: 140 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Histweet
[](https://codecov.io/gh/aksiksi/histweet)
`histweet` is a simple CLI tool that automatically manages your Twitter timeline.
By default, due to limits in the Twitter API, `histweet` can only process that latest 3,200 tweets in your timeline. However, if you point `histweet` to an optional [Twitter archive](https://help.twitter.com/en/managing-your-account/how-to-download-your-twitter-archive), the tool can process tweets based on your entire history.
## Prerequisites
Before you can use `histweet`, you must first obtain a Twitter API key and access token. To do this, signup for a Twitter Developer account [here](https://developer.twitter.com/en/apply-for-access).
Once you have your keys, you can either pass them in as CLI flags or define the following environment variables:
```
$ export HISTWEET_ACCESS_TOKEN=[YOUR_KEY]
$ export HISTWEET_ACCESS_SECRET=[YOUR_KEY]
$ export HISTWEET_CONSUMER_KEY=[YOUR_KEY]
$ export HISTWEET_CONSUMER_SECRET=[YOUR_KEY]
```
## Quickstart
`histweet` comes with two basic modes: count mode and rules mode.
### Count Mode
In count mode, `histweet` just keeps the latest `N` tweets. For example, we can keep the latest 300 tweets and delete everything else like so (`--daemon` keeps `histweet` running in the background).
```
histweet count -n 300 --daemon
```
### Rule Mode
Rule mode is the more powerful and... practical mode. In this mode, you can specify one or more *rules*. `histweet` will delete **all** tweets that match the provided rule(s).
In this example, we delete all tweets that are:
1. Older than 3 months and 5 days, and;
2. Have fewer than 3 likes, and;
3. Contain the word "dt" (as a regex pattern)
```
histweet rule 'age > 3m5d && likes < 3 && text ~ "dt"'
```
To point `histweet` at your archive JSON, pass in the `--archive` flag like so:
```
histweet rule --archive /path/to/tweet.js 'age > 3m5d && likes < 3 && text ~ "dt"'
```
The tool will now run the same rules against the contents of your archive, and then use the Twitter API to delete all matching tweets.
You can view full usage by passing in the `-h` flag.
## Build
`cd cli && go build -o histweet`
## Test
`cd lib && go test`
## Benches
```
cd lib
# Run benchmarks & dump files for CPU and mem
go test -bench=. -benchmem -memprofile=mem.out -cpuprofile=cpu.out
# Optional: analyze each file in browser using pprof
go tool pprof -http :8080 cpu.out
go tool pprof -http :8081 mem.out
```