https://github.com/muesli/mastotool
A collection of command-line tools to work with your Mastodon account
https://github.com/muesli/mastotool
hacktoberfest
Last synced: 11 months ago
JSON representation
A collection of command-line tools to work with your Mastodon account
- Host: GitHub
- URL: https://github.com/muesli/mastotool
- Owner: muesli
- License: mit
- Created: 2018-11-22T03:23:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-18T18:51:06.000Z (over 2 years ago)
- Last Synced: 2025-08-15T22:35:43.167Z (11 months ago)
- Topics: hacktoberfest
- Language: Go
- Homepage:
- Size: 102 KB
- Stars: 99
- Watchers: 6
- Forks: 9
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - muesli/mastotool - A collection of command-line tools to work with your Mastodon account (hacktoberfest)
README
mastotool
=========
[](https://github.com/muesli/mastotool/releases)
[](https://github.com/muesli/mastotool/actions)
[](https://goreportcard.com/report/muesli/mastotool)
[](https://pkg.go.dev/github.com/muesli/mastotool)
mastotool offers a collection of command-line tools to work with your Mastodon account
## Installation
### Packages
#### Linux
- Arch Linux: [mastotool](https://aur.archlinux.org/packages/mastotool/)
- [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
### From source
Make sure you have a working Go environment (Go 1.9 or higher is required).
See the [install instructions](https://golang.org/doc/install.html).
Compiling mastotool is easy, simply run:
git clone https://github.com/muesli/mastotool.git
cd mastotool
go build
## Usage
```
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
```
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
```
mastotool search
```
## Example
```
$ 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%
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)
Users you mentioned most Interactions
----------------------------------------------------------------------------------
abc 9
def 3
Users you boosted most Interactions
----------------------------------------------------------------------------------
xyz 7
zyx 2
Users that responded most Interactions
----------------------------------------------------------------------------------
def 11
fed 9
Most replied-to toots Replies
----------------------------------------------------------------------------------
Some toot 20
Another toot 7
Most liked toots Likes
----------------------------------------------------------------------------------
Some toot 50
Another toot 8
Most boosted toots Boosts
----------------------------------------------------------------------------------
Some toot 10
Another toot 4
Highest scoring toots Score
----------------------------------------------------------------------------------
Some toot 80
Another toot 20
Tags used that got the most likes Likes
----------------------------------------------------------------------------------
Some tag 10
Another tag 4
Tags used that got the most boosts Boosts
----------------------------------------------------------------------------------
Some tag 5
Another tag 1
```