https://github.com/xandkar/tt
A client and a crawler of twtxt (a P2P microblogging network).
https://github.com/xandkar/tt
twtxt twtxt-client
Last synced: 7 months ago
JSON representation
A client and a crawler of twtxt (a P2P microblogging network).
- Host: GitHub
- URL: https://github.com/xandkar/tt
- Owner: xandkar
- Created: 2020-11-10T04:48:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-17T22:36:20.000Z (almost 4 years ago)
- Last Synced: 2024-10-19T03:06:41.812Z (12 months ago)
- Topics: twtxt, twtxt-client
- Language: Racket
- Homepage: https://xandkar.net/twtxt/
- Size: 1.51 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
tt
==
A more-unixy [twtxt](https://github.com/buckket/twtxt) client.
[](https://travis-ci.org/xandkar/tt)
Doesn't force you to maintain a master "following" file (the way Twitter does),
but let's you point it to any follow-file every time it runs.
This means unlimited possibilities for ad-hoc, interesting filtering
combinations. Especially when paired with
[process substitution](https://en.wikipedia.org/wiki/Process_substitution).
### long format (default)
### short format (CLI option: -s)
instructions
------------
### requirements
#### manual
[Racket](https://download.racket-lang.org/)
#### package manager
- Void Linux: `xbps-install racket`
- Debian: `apt install racket`
### installation
`make build && make install` will build and copy `tt` binary into
`$PREFIX/bin`, where `$PREFIX` defaults to `$HOME`.
### configuration
Put your `` and `` into `~/.tt/me`. For example, mine is:
```
$ cat ~/.tt/me
xandkar https://xandkar.net/twtxt.txt
```
It will be used to fill the `User-Agent` header, so that others can tell you're
reading their twtxts and perhaps read yours. This isn't strictly necessary and
if omitted, you'll stay anonymous.
### usage
$ tt --help
tt [ ... ] [] ...
where is one of
-d, --debug : Enable debug log level.
and is one of
r, read : Read the timeline (offline operation).
d, download : Download the timeline.
u, upload : Upload your twtxt file (alias to execute ~/.tt/upload).
c, crawl : Discover new peers mentioned by known peers (offline operation).
--help, -h : Show this help
-- : Do not treat any remaining argument as a switch (at this level)
Multiple single-letter switches can be combined after one `-'; for
example: `-h-' is the same as `-h --'
#### download
peers' feeds from the Internet:
$ tt d -h
tt download [ ... ] [] ...
where is one of
-j , --jobs : Number of concurrent jobs.
--help, -h : Show this help
-- : Do not treat any remaining argument as a switch (at this level)
Multiple single-letter switches can be combined after one `-'; for
example: `-h-' is the same as `-h --'
#### read
your timeline:
$ tt r -h
tt read [ ... ] [] ...
where is one of
-r, --rev : Reverse displayed timeline order.
/ -s, --short : Short output format
\ -l, --long : Long output format
--help, -h : Show this help
-- : Do not treat any remaining argument as a switch (at this level)
/|\ Brackets indicate mutually exclusive options.
Multiple single-letter switches can be combined after one `-'; for
example: `-h-' is the same as `-h --'
`FOLLOW-FILE` contains lines with space-separated nick and twtxt.txt URI, like:
```
xandkar https://xandkar.net/twtxt.txt
```
If omitted, `FOLLOW-FILE` defaults to `~/.tt/peers`.
#### other commands
tt -h
notes
-----
### LWW downloads
Downloaded timelines are stored in `~/.tt/cache/objects/`, but
no attempt is made to preserve the previously-downloaded messages - each
download overrites the previous. One of the implications is that authors can
edit/delete history without you noticing.