Skip to main content

Interact with Mastodon social networks from the command line.

Project description

Interact with Mastodon social networks from the command line.

https://img.shields.io/travis/ihabunek/toot.svg?maxAge=3600&style=flat-square https://img.shields.io/badge/author-%40ihabunek-blue.svg?maxAge=3600&style=flat-square https://img.shields.io/github/license/ihabunek/pdf417-py.svg?maxAge=3600&style=flat-square https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square

Installation

Install using pip:

pip install toot

Usage

Running toot displays a list of available commands.

Running toot <command> -h shows the documentation for the given command.

$ toot

toot - a Mastodon CLI client

Authentication:
  toot login       Log into a Mastodon instance
  toot login_2fa   Log in using two factor authentication (experimental)
  toot logout      Log out, delete stored access keys
  toot auth        Show stored credentials

Read:
  toot whoami      Display logged in user details
  toot whois       Display account details
  toot search      Search for users or hashtags
  toot timeline    Show recent items in your public timeline
  toot curses      An experimental timeline app.

Post:
  toot post        Post a status text to your timeline
  toot upload      Upload an image or video file

Accounts:
  toot follow      Follow an account
  toot unfollow    Unfollow an account
  toot mute        Mute an account
  toot unmute      Unmute an account
  toot block       Block an account
  toot unblock     Unblock an account

To get help for each command run:
  toot <command> --help

https://github.com/ihabunek/toot

It is possible to pipe status text into toot post, for example:

echo "Text to post" | toot post
cat mypost.txt | toot post

Authentication

Before tooting, you need to login to a Mastodon instance:

toot login

Two factor authentication is supported experimentally, instead of login, you should instead run login_2fa:

toot login_2fa

You will be asked to chose an instance and enter your credentials.

The application and user access tokens will be saved in two files in your home directory:

  • ~/.config/toot/instances/<name> - created for each mastodon instance once
  • ~/.config/toot/user.cfg

You can check whether you are currently logged in:

toot auth

And you can logout which will remove the stored access tokens:

toot logout

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
toot-0.11.0-py2.py3-none-any.whl (15.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3
toot-0.11.0.tar.gz (12.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page