Toot is a CLI and TUI tool for interacting with Mastodon instances from the command line.
 
 
 
Go to file
Ivan Habunek f5a465ff25
Implement vim-like commands in footer
2023-01-20 09:54:37 +01:00
.github/workflows Run tests on pull requests 2023-01-01 11:11:10 +01:00
docs Remove coding directives, no longer needed 2022-12-31 09:31:32 +01:00
scripts Add checks to tag script 2019-09-03 16:45:31 +02:00
tests Expand tests 2023-01-02 11:53:50 +01:00
toot Implement vim-like commands in footer 2023-01-20 09:54:37 +01:00
.coveragerc Set up code coverage 2022-11-29 11:54:45 +01:00
.flake8 Ignore venv folder for flake8 and vermin tests 2023-01-19 09:17:52 +01:00
.gitignore Remove deb packaging leftovers 2022-11-12 15:29:19 +01:00
.travis.yml Use make command to run tests (for real now) 2019-09-18 21:55:35 +02:00
CHANGELOG.md Bump version 2023-01-03 12:05:26 +01:00
CONTRIBUTING.md Improve contribution guidelines 2023-01-01 12:24:32 +01: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 Ignore venv folder for flake8 and vermin tests 2023-01-19 09:17:52 +01:00
README.rst Add link to mailing list, move chat to libera 2021-05-24 15:43:52 +02:00
changelog.yaml Bump version 2023-01-03 12:05:26 +01:00
requirements-dev.txt Add github actions workflow 2022-12-02 09:27:14 +01:00
requirements-test.txt Add flake8 to test dependencies 2022-12-27 12:17:31 +01:00
requirements.txt Don't limit upper version on wcwidth 2022-11-12 09:26:31 +01:00
setup.py Bump version 2023-01-03 12:05:26 +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/travis/ihabunek/toot.svg?maxAge=3600&style=flat-square
   :target: https://travis-ci.org/ihabunek/toot
.. 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.readthedocs.io/en/latest/
* 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/_static/tui_list.png

.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/_static/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>`_.