Toot is a CLI and TUI tool for interacting with Mastodon instances from the command line.
 
 
Go to file
Ivan Habunek 1e76efa27d Upgrade urwid and require python 3.9
Because urwid3 required python 3.9, and 3.8 is EOL.
2025-07-31 09:21:36 +02:00
.github/workflows Skip style checking on CI 2025-03-06 09:58:16 +01:00
docs Add testing docs for sharkey 2025-07-29 08:46:04 +02:00
scripts Tweak commit message script 2025-03-06 10:26:51 +01:00
tests Use dateutil to parse datetimes 2025-03-06 09:47:29 +01:00
toot Don't log exception inside tui 2025-07-29 10:02:35 +02:00
.coveragerc Set up code coverage 2022-11-29 11:54:45 +01:00
.flake8 Added 'toot diag' command that outputs useful diagnostic info 2024-06-13 20:35:45 -04:00
.gitignore Ignore uv lock 2025-01-11 08:58:03 +01:00
.vermin Upgrade urwid and require python 3.9 2025-07-31 09:21:36 +02:00
CHANGELOG.md Update docs 2025-03-06 11:52:12 +01:00
CONTRIBUTING.md Update Setting up dev environnement (#496) 2024-09-29 09:35:19 +02:00
LICENSE Change license to GPLv3 2017-05-08 09:17:32 +02:00
MANIFEST.in Include tests in sdist 2019-09-18 08:05:07 +02:00
Makefile Use build for packaging 2024-04-13 09:09:17 +02:00
README.rst Updated images and readme 2024-08-12 09:52:36 +02:00
book.css Add new mdbook docs 2023-03-03 13:55:20 +01:00
book.toml Add new mdbook docs 2023-03-03 13:55:20 +01:00
changelog.yaml Update changelog 2025-03-06 11:50:11 +01:00
pyproject.toml Upgrade urwid and require python 3.9 2025-07-31 09:21:36 +02:00
pytest.ini Limit test files 2023-12-05 08:58:31 +01:00
trumpet.png Resize image 2018-06-25 14:30:18 +02:00

README.rst

============================
Toot - a Mastodon CLI client
============================

.. image:: https://raw.githubusercontent.com/ihabunek/toot/master/trumpet.png

Toot is a CLI and TUI tool for interacting with Mastodon instances from the command line.

.. image:: https://img.shields.io/badge/author-%40ihabunek-blue.svg?maxAge=3600&style=flat-square
   :target: https://mastodon.social/@ihabunek
.. image:: https://img.shields.io/github/license/ihabunek/toot.svg?maxAge=3600&style=flat-square
   :target: https://opensource.org/licenses/GPL-3.0
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
   :target: https://pypi.python.org/pypi/toot

Resources
---------

* Homepage: https://github.com/ihabunek/toot
* Issues: https://github.com/ihabunek/toot/issues
* Documentation: https://toot.bezdomni.net/
* Mailing list for discussion, support and patches:
  https://lists.sr.ht/~ihabunek/toot-discuss
* Informal discussion: #toot IRC channel on `libera.chat <https://libera.chat/>`_

Features
--------

* Posting, replying, deleting statuses
* Support for media uploads, spoiler text, sensitive content
* Search by account or hash tag
* Following, muting and blocking accounts
* Simple switching between authenticated in Mastodon accounts

Terminal User Interface
-----------------------

toot includes a terminal user interface (TUI). Run it with ``toot tui``.

TUI Features:
-------------

* Block graphic image display (requires optional libraries `pillow <https://pypi.org/project/pillow/>`, `term-image <https://pypi.org/project/term-image/>`, and `urwidgets <https://pypi.org/project/urwidgets/>`)
* Bitmapped image display in `kitty <https://sw.kovidgoyal.net/kitty/>` terminal ``toot tui -f kitty``
* Bitmapped image display in `iTerm2 <https://iterm2.com/>`, or `WezTerm <https://wezfurlong.org/wezterm/index.html>` terminal ``toot tui -f iterm``


.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_list.png

.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_compose.png

License
-------

Copyright Ivan Habunek <ivan@habunek.com> and contributors.

Licensed under `GPLv3 <http://www.gnu.org/licenses/gpl-3.0.html>`_, see `LICENSE <LICENSE>`_.