witchie/README.rst
2017-04-16 15:07:27 +02:00

72 lines
2.2 KiB
ReStructuredText

=============================
Toot - Mastodon CLI interface
=============================
Interact with Mastodon social networks 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/pdf417-py.svg?maxAge=3600&style=flat-square
:target: https://opensource.org/licenses/MIT
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
:target: https://pypi.python.org/pypi/toot
Installation
------------
Install using pip:
.. code-block::
pip install toot
Usage
-----
Running ``toot`` displays a list of available commands.
Running ``toot <command> -h`` shows the documentation for the given command.
=================== ===============================================================
Command Description
=================== ===============================================================
``toot login`` Log into a Mastodon instance, saves access keys for later use.
``toot logout`` Log out, deletes stored access keys.
``toot auth`` Display current login details.
``toot post`` Post a status to your timeline.
``toot search`` Search for accounts or hashtags.
``toot timeline`` Display recent items in your public timeline.
=================== ===============================================================
Authentication
--------------
Before tooting, you need to login to a Mastodon instance:
.. code-block::
toot login
You will be asked to chose an instance_ and enter your credentials.
.. _instance: https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md
The application and user access tokens will be saved in two files in your home directory:
* ``~/.config/toot/app.cfg``
* ``~/.config/toot/user.cfg``
You can check whether you are currently logged in:
.. code-block::
toot auth
And you can logout which will remove the stored access tokens:
.. code-block::
toot logout