Toot is a CLI and TUI tool for interacting with Mastodon instances from the command line.
 
 
Go to file
Ivan Habunek d805cdffa5
Don't swallow random exceptions
Catching any exception here will not display an error if e.g. entitiy
conversion fails.
2025-03-06 09:47:28 +01:00
.github/workflows
docs Update changelog 2024-11-27 19:59:29 +01:00
scripts
tests Test new timeline commands, tweaks 2025-01-16 15:09:21 +01:00
toot Don't swallow random exceptions 2025-03-06 09:47:28 +01:00
.coveragerc
.flake8
.gitignore Ignore uv lock 2025-01-11 08:58:03 +01:00
.vermin
CHANGELOG.md Update changelog 2024-11-27 19:59:29 +01:00
CONTRIBUTING.md
LICENSE
MANIFEST.in
Makefile
README.rst
book.css
book.toml
changelog.yaml Remove deprecated lists command 2025-01-16 13:58:30 +01:00
pyproject.toml Remove accidental textual-dev dependency 2025-01-16 13:59:44 +01:00
pytest.ini
trumpet.png

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>`_.