Toot-Mastodon-CLI-TUI-clien.../README.rst

119 lines
3.1 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
Interact with Mastodon social networks from the command line.
2017-04-16 15:07:27 +02:00
.. image:: https://img.shields.io/travis/ihabunek/toot.svg?maxAge=3600&style=flat-square
:target: https://travis-ci.org/ihabunek/toot
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
.. 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
2017-04-12 16:42:04 +02:00
Installation
------------
Install using pip:
.. code-block::
pip install toot
Usage
-----
2017-04-16 15:07:27 +02:00
Running ``toot`` displays a list of available commands.
Running ``toot <command> -h`` shows the documentation for the given command.
2017-04-19 14:47:30 +02:00
.. code-block::
$ toot
toot - a Mastodon CLI client
Authentication:
2017-04-19 14:47:30 +02:00
toot login Log into a Mastodon instance
toot login_2fa Log in using two factor authentication (experimental)
toot logout Log out, delete stored access keys
toot auth Show stored credentials
Read:
2017-04-19 14:47:30 +02:00
toot whoami Display logged in user details
toot whois Display account details
toot search Search for users or hashtags
toot timeline Show recent items in your public timeline
toot curses An experimental timeline app.
Post:
2017-04-19 14:47:30 +02:00
toot post Post a status text to your timeline
toot upload Upload an image or video file
Accounts:
2017-04-19 14:47:30 +02:00
toot follow Follow an account
toot unfollow Unfollow an account
toot mute Mute an account
toot unmute Unmute an account
toot block Block an account
toot unblock Unblock an account
2017-04-19 14:47:30 +02:00
To get help for each command run:
toot <command> --help
https://github.com/ihabunek/toot
2017-04-19 14:51:30 +02:00
It is possible to pipe status text into `toot post`, for example:
.. code-block::
echo "Text to post" | toot post
cat mypost.txt | toot post
2017-04-16 15:07:27 +02:00
Authentication
--------------
Before tooting, you need to login to a Mastodon instance:
2017-04-12 16:42:04 +02:00
.. code-block::
2017-04-13 13:52:28 +02:00
toot login
2017-04-19 14:55:41 +02:00
**Two factor authentication** is supported experimentally, instead of ``login``, you should instead run ``login_2fa``:
.. code-block::
2017-04-19 14:55:41 +02:00
toot login_2fa
2017-04-13 13:52:28 +02:00
You will be asked to chose an instance_ and enter your credentials.
2017-04-12 16:42:04 +02:00
2017-04-13 13:52:28 +02:00
.. _instance: https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md
2017-04-12 17:18:56 +02:00
2017-04-13 13:52:28 +02:00
The application and user access tokens will be saved in two files in your home directory:
2017-04-12 17:18:56 +02:00
* ``~/.config/toot/instances/<name>`` - created for each mastodon instance once
2017-04-12 17:18:56 +02:00
* ``~/.config/toot/user.cfg``
2017-04-13 13:52:28 +02:00
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
2017-05-08 09:17:32 +02:00
License
-------
Copyright © 2017 Ivan Habunek <ivan@habunek.com>
Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html