Toot is a CLI and TUI tool for interacting with Mastodon instances from the command line.
 
 
 
Go to file
Ivan Habunek 69a11f3569
Remove old mock tests
These will be replaced by simpler and more useful integration tests.
2023-12-02 11:10:36 +01:00
.github/workflows Add a config file for vermin 2023-11-18 22:20:06 +01:00
docs Add release date 2023-11-23 11:34:14 +01:00
scripts Add checks to tag script 2019-09-03 16:45:31 +02:00
tests Remove old mock tests 2023-12-02 11:10:36 +01:00
toot Migrate auth commands 2023-11-30 20:12:04 +01:00
.coveragerc Set up code coverage 2022-11-29 11:54:45 +01:00
.flake8 Make account optional in following and followers 2023-11-22 08:22:21 +01:00
.gitignore Ignore venv 2023-06-22 12:15:05 +02:00
.vermin Add a config file for vermin 2023-11-18 22:20:06 +01:00
CHANGELOG.md Add release date 2023-11-23 11:34:14 +01:00
CONTRIBUTING.md Clarify misleading venv docs 2023-09-23 17:58:07 +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 Migrate auth commands 2023-11-30 20:12:04 +01:00
README.rst Remove travis from readme and docs 2023-06-22 11:24:05 +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 Migrate auth commands 2023-11-30 20:12:04 +01:00
setup.py Setup click, migrate read commands 2023-11-28 10:13:05 +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``.

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