mastotool/README.md

134 lines
5.4 KiB
Markdown
Raw Permalink Normal View History

2019-08-11 04:12:37 +02:00
mastotool
=========
2018-11-22 04:35:51 +01:00
2020-08-23 07:05:04 +02:00
[![Latest Release](https://img.shields.io/github/release/muesli/mastotool.svg)](https://github.com/muesli/mastotool/releases)
[![Build Status](https://github.com/muesli/mastotool/workflows/build/badge.svg)](https://github.com/muesli/mastotool/actions)
2021-05-19 06:46:50 +02:00
[![Go ReportCard](https://goreportcard.com/badge/muesli/mastotool)](https://goreportcard.com/report/muesli/mastotool)
2020-08-23 07:05:04 +02:00
[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://pkg.go.dev/github.com/muesli/mastotool)
2020-10-06 04:15:37 +02:00
mastotool offers a collection of command-line tools to work with your Mastodon account
2018-11-22 04:35:51 +01:00
## Installation
2020-10-06 04:15:37 +02:00
### Packages
2019-08-11 22:06:46 +02:00
2020-10-06 04:15:37 +02:00
#### Linux
2019-08-11 22:06:46 +02:00
- Arch Linux: [mastotool](https://aur.archlinux.org/packages/mastotool/)
2020-10-06 04:15:37 +02:00
- [Packages](https://github.com/muesli/mastotool/releases) in Debian & RPM formats
#### macOS
- macOS with [Homebrew](https://brew.sh/): `brew tap muesli/tap && brew install mastotool`
### Binaries
- [Binaries](https://github.com/muesli/mastotool/releases) for Linux, FreeBSD, OpenBSD, macOS & Windows
2019-08-11 22:06:46 +02:00
### From source
2019-09-18 02:30:55 +02:00
Make sure you have a working Go environment (Go 1.9 or higher is required).
2021-05-19 06:46:50 +02:00
See the [install instructions](https://golang.org/doc/install.html).
2018-11-22 04:35:51 +01:00
2019-08-11 22:06:46 +02:00
Compiling mastotool is easy, simply run:
2018-11-22 04:35:51 +01:00
git clone https://github.com/muesli/mastotool.git
2019-08-11 22:35:36 +02:00
cd mastotool
go build
2018-11-22 04:35:51 +01:00
## Usage
```
2019-08-11 22:07:45 +02:00
mastotool [command]
Available Commands:
help Help about any command
search searches your toots
stats generates statistics about your account
Flags:
-c, --config string uses the specified config file (default "mastodon.json")
-h, --help help for mastotool
Use "mastotool [command] --help" for more information about a command.
```
### Generate Statistics
```
2019-08-11 22:07:45 +02:00
mastotool stats [flags]
Flags:
--columns int displays tables with N columns (default 80)
-r, --recent int only account for the N most recent toots (excl replies & boosts)
-t, --top int shows the top N items in each category (default 10)
```
### Search
```
2019-08-11 22:07:45 +02:00
mastotool search <string>
2018-11-22 04:42:35 +01:00
```
## Example
2018-11-22 04:35:51 +01:00
2018-11-22 04:42:35 +01:00
```
$ mastotool stats -r 100
Which instance to connect to: https://mastodon.social
Username (email): some_user@domain.tld
Password: ********
Loading toots for some_user 100 of 100 [############################>] 100.00%
2018-11-22 04:35:51 +01:00
Total toots: 100 (excluding replies & boosts)
Toots per day: 1.00 (account created 100 days ago)
Ratio toots/replies: 0.33
New followers per day: 7.41
New followings per day: 3.67
Likes per toot: 9.00 (total likes: 900)
Boosts per toot: 2.50 (total boosts: 250)
Replies per toot: 3.40 (total replies: 340)
2018-11-22 04:35:51 +01:00
Users you mentioned most Interactions
----------------------------------------------------------------------------------
abc 9
def 3
2018-11-22 04:35:51 +01:00
Users you boosted most Interactions
----------------------------------------------------------------------------------
xyz 7
zyx 2
2018-11-22 04:35:51 +01:00
Users that responded most Interactions
----------------------------------------------------------------------------------
def 11
fed 9
2018-11-22 04:35:51 +01:00
Most replied-to toots Replies
----------------------------------------------------------------------------------
Some toot 20
Another toot 7
2018-11-22 04:35:51 +01:00
Most liked toots Likes
----------------------------------------------------------------------------------
Some toot 50
Another toot 8
2018-11-22 04:35:51 +01:00
Most boosted toots Boosts
----------------------------------------------------------------------------------
Some toot 10
Another toot 4
2018-11-22 04:35:51 +01:00
Highest scoring toots Score
----------------------------------------------------------------------------------
Some toot 80
Another toot 20
2018-11-22 04:35:51 +01:00
Tags used that got the most likes Likes
----------------------------------------------------------------------------------
Some tag 10
Another tag 4
2018-11-22 04:35:51 +01:00
Tags used that got the most boosts Boosts
----------------------------------------------------------------------------------
Some tag 5
Another tag 1
2018-11-22 04:35:51 +01:00
```