Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Interact with Mastodon social networks from the command line.

Project description

Toot - a Mastodon CLI client

Interact with Mastodon social networks from the command line.

.. image::
.. image::
.. image::
.. image::


>From APT package repository

This works for Debian, Ubuntu and derivatives.

The repo is signed with my ` <>`_ key.

Add the `` repository:

.. code-block::

echo "deb ./" | sudo tee /etc/apt/sources.list.d/bezomni.list
curl | sudo apt-key add -

Install the package:

.. code-block::

sudo apt update
sudo apt install python3-toot

>From Python Package Index

Otherwise, install from PyPI using pip, preferably into a virtual environment:

.. code-block::

pip install toot


Running ``toot`` displays a list of available commands.

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

.. code-block::

$ toot

toot - a Mastodon CLI client

toot login Log into a Mastodon instance, does NOT support two factor authentication
toot login_browser Log in using your browser, supports regular and two factor authentication
toot login_2fa Log in using two factor authentication in the console (hacky, experimental)
toot logout Log out, delete stored access keys
toot auth Show stored credentials

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.

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

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

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

.. code-block::

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


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

If you don't use two factor authentication you can log in directly from the command line:

.. code-block::

toot login

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

If you do use **two factor authentication**, you need to log in through your browser:

.. code-block::

toot login_browser

You will be redirected to your Mastodon instance to log in and authorize toot to access your account, and will be given an **authorization code** in return which you need to enter to log in.

.. _instance:

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:

.. code-block::

toot auth

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

.. code-block::

toot logout


Copyright © 2017 Ivan Habunek <>

Licensed under the GPLv3:

Project details

Download files

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

Files for toot, version 0.15.0
Filename, size File type Python version Upload date Hashes
Filename, size toot-0.15.0-py2.py3-none-any.whl (17.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size toot-0.15.0.tar.gz (12.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page