1
0
mirror of https://github.com/ihabunek/toot synced 2024-12-21 06:30:26 +01:00
Toot-Mastodon-CLI-TUI-clien.../README.rst

58 lines
2.2 KiB
ReStructuredText
Raw Normal View History

2017-05-08 09:17:32 +02:00
============================
Toot - a Mastodon CLI client
============================
2017-04-12 17:23:50 +02:00
.. image:: https://raw.githubusercontent.com/ihabunek/toot/master/trumpet.png
2019-09-03 16:12:16 +02:00
Toot is a CLI and TUI tool for interacting with Mastodon instances from the command line.
2017-04-12 17:23:50 +02:00
.. image:: https://img.shields.io/badge/author-%40ihabunek-blue.svg?maxAge=3600&style=flat-square
:target: https://mastodon.social/@ihabunek
2017-08-26 11:35:20 +02:00
.. image:: https://img.shields.io/github/license/ihabunek/toot.svg?maxAge=3600&style=flat-square
2020-06-15 20:23:31 +02:00
:target: https://opensource.org/licenses/GPL-3.0
2017-04-12 17:23:50 +02:00
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
:target: https://pypi.python.org/pypi/toot
2017-04-12 16:42:04 +02:00
2019-02-15 14:20:23 +01:00
Resources
---------
2018-06-12 12:14:18 +02:00
2019-02-15 14:20:23 +01:00
* Homepage: https://github.com/ihabunek/toot
* Issues: https://github.com/ihabunek/toot/issues
2023-03-03 16:54:40 +01:00
* 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/>`_
2018-06-12 12:14:18 +02:00
Features
--------
2018-06-12 12:14:18 +02:00
* Posting, replying, deleting statuses
* Support for media uploads, spoiler text, sensitive content
* Search by account or hash tag
* Following, muting and blocking accounts
2018-08-21 00:42:46 +02:00
* Simple switching between authenticated in Mastodon accounts
2018-06-12 12:14:18 +02:00
2019-09-02 09:04:42 +02:00
Terminal User Interface
-----------------------
2018-06-12 12:14:18 +02:00
2020-06-15 21:27:41 +02:00
toot includes a terminal user interface (TUI). Run it with ``toot tui``.
2019-08-29 13:44:06 +02:00
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``
2023-04-18 20:53:55 +02:00
.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_list.png
2019-08-29 13:44:06 +02:00
2023-04-18 20:53:55 +02:00
.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_compose.png
2018-06-12 12:14:18 +02:00
2017-05-08 09:17:32 +02:00
License
-------
2020-06-15 20:23:02 +02:00
Copyright Ivan Habunek <ivan@habunek.com> and contributors.
2017-05-08 09:17:32 +02:00
Licensed under `GPLv3 <http://www.gnu.org/licenses/gpl-3.0.html>`_, see `LICENSE <LICENSE>`_.