Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/embano1/tw
A Minimalistic Twitter CLI Client
https://github.com/embano1/tw
Last synced: about 1 month ago
JSON representation
A Minimalistic Twitter CLI Client
- Host: GitHub
- URL: https://github.com/embano1/tw
- Owner: embano1
- Created: 2018-01-05T10:25:14.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2023-12-18T23:32:29.000Z (12 months ago)
- Last Synced: 2024-08-01T12:23:09.837Z (4 months ago)
- Language: Go
- Size: 11.7 MB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
- awesome-starred - embano1/tw - A Minimalistic Twitter CLI Client (others)
README
# What's `tw`?
It turned out that it's not just me who (ab)uses the Twitter `Like` button for a
"read later" list :)
`tw` is a very basic Twitter client to query your Likes, and do some powerful
JSON filtering (see examples below).
Currently, only `Likes` can be queried. `tw` is expandable though ;)
Please keep ideas and bugs coming (file an
[Issue](https://github.com/embano1/tw/issues)).
# Get it
## Releases (Binaries)
Download a release for `OSX`, `Windows` and `Linux` from the
[Releases](https://github.com/embano1/tw/releases) page.
## Docker
```bash
docker pull ghcr.io/embano1/tw:latest
```
## Homebrew 🍺
```bash
# Tap tw repository and install
brew install embano1/tw/tw
```
# Usage
> **Note** You first need to set up authentication, see
> [Authentication](#authenticate-tw-via-file) section below.
After you downloaded a release and with authentication set up:
```bash
# OSX/ Linux Quick start with your credentials in /auth.json
./tw likes -f ~/auth.json --pretty
(tweets...)
```
Or with `Docker` installed:
```bash
# Quick start with your credentials in /auth.json
docker run --rm -it -v ~/auth.json:/auth.json ghcr.io/embano1/tw:latest tw -f /auth.json -p likes
(...)
# If you have a JSON parser like 'jq' installed, this works as well
# Running without "-it" because this could mess up JSON printing on the CLI
docker run --rm -v ~/auth.json:/auth.json ghcr.io/embano1/tw:latest tw -f /auth.json likes | jq '.[]|"---------",.user.screen_name,.full_text,.entities.urls[].expanded_url'
(...)
# If you don't have a JSON parser installed, use the one provided in the image
docker run --rm -it -v ~/auth.json:/auth.json ghcr.io/embano1/tw:latest sh
# Now inside the container...
/ tw -f /auth.json likes | jq '.[]|"---------",.user.screen_name,.full_text,.entities.urls[].expanded_url'
(...)
```
## Help and Flags
```
./tw --help
usage: tw [] [ ...]
______ __ __
/\__ _\ /\ \ _ \ \
\/_/\ \/ \ \ \/ ".\ \
\ \_\ \ \__/".~\_\
\/_/ \/_/ \/_/
A minimal Twitter CLI
This application uses Oauthv1 to securely authenticate requests.
You can obtain API credentials from https://apps.twitter.com/.
Always handle secrets carefully!
Example:
tw -f twitter_credentials.json likes
Flags:
-h, --help Show context-sensitive help (also try --help-long and --help-man).
-v, --version Show application version.
-f, --file=FILE Path to a JSON file containing auth credentials
-p, --pretty Pretty print instead of JSON (default: JSON)
Commands:
help [...]
Show help.
likes
Get your likes
```
# Filtering with `jq`
> [jq](https://stedolan.github.io/jq/) is like sed for JSON data.
> You can use it to slice and filter and map and transform structured data with
> the same ease that sed, awk, grep and friends let you play with text.
>
> [Tutorial](https://stedolan.github.io/jq/tutorial/) and
> [Manual](https://stedolan.github.io/jq/manual/)
## Examples
```bash
# Nicer JSON output
./tw -f auth.json likes | jq '.'
# Count number of your likes
./tw -f auth.json likes | jq '[.[].id]|length'
# Query links in your likes
./tw -f auth.json likes | jq '.[].entities.urls[].expanded_url'
# Print username and Tweet text
./tw -f auth.json likes | jq '.[]|"---------",.user.screen_name,.full_text'
```
# Authentication
This application uses OAuthv1 to securely authenticate requests. You can obtain
API credentials from https://apps.twitter.com/. See below for a detailed
description.
**Always handle secrets carefully!**
## Authenticate `tw` via File
```bash
# Create auth.json file in the 'tw' folder, e.g. on Linux/ OSX
touch auth.json
```
Copy and paste everything below into `auth.json` (replace values with your own).
```json
{
"Consumer_Key": "AAAAAAAAAAAAAAAAAAAAA",
"Consumer_Secret": "AAAAAAAAAAAAAAAAAAAAA",
"Access_Token": "1234567-AAAAAAAAAAAAAAAAAAAAA",
"Access_Token_Secret": "AAAAAAAAAAAAAAAAAAAAA"
}
```
Test it...
```bash
./twfaves -f auth.json -p
```
## Step-by-Step Guide to create Authorization Credentials
Log in at [https://apps.twitter.com](https://apps.twitter.com) your Twitter
account. Select `Create New App`.
Insert application details. Note: the name must be a unique (not already taken),
e.g. append a number.
Create application and click on `Key and Access Tokens`. Bonus point: reduce
permissions to `Read Only` (`tw` does not require write access).
Now click `Create my access token`.
Use `Consumer Key`, `Consumer Secret`, `Access Token`, and `Access Token Secret`
in your auth.json file or set the corresponding environment variables.
## Build
Requires a working [go](https://golang.org/) environment.
```bash
git clone https://github.com/embano1/tw
cd tw
# Builds a static binary for your GOOS
go build .
```