Replace docs in README with link rtfd.io
This commit is contained in:
parent
05086e0c1f
commit
b9fd3bf98b
3 changed files with 69 additions and 189 deletions
184
README.rst
184
README.rst
|
|
@ -15,182 +15,32 @@ Interact with Mastodon social network from the command line.
|
||||||
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
|
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
|
||||||
:target: https://pypi.python.org/pypi/toot
|
:target: https://pypi.python.org/pypi/toot
|
||||||
|
|
||||||
Installation
|
Documentation
|
||||||
------------
|
-------------
|
||||||
|
|
||||||
Debian Buster
|
Documentation is hosted on readthedocs.io. Check it out for instruction on installation, usage and more.
|
||||||
~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
If you're running Debian Buster (testing), toot is available in the Debian
|
https://toot.readthedocs.io/en/latest/
|
||||||
package repository.
|
|
||||||
|
|
||||||
.. code-block::
|
Features
|
||||||
|
--------
|
||||||
|
|
||||||
sudo apt install toot
|
* Posting, replying, deleting statuses
|
||||||
|
* Support for media uploads, spoiler text, sensitive content
|
||||||
|
* Search by account or hash tag
|
||||||
|
* Following, muting and blocking accounts
|
||||||
|
* Simple swithcing between authenticated in Mastodon accounts
|
||||||
|
|
||||||
Debian package is maintained by `Jonathan Carter <https://mastodon.xyz/@highvoltage>`_.
|
Curses UI
|
||||||
|
---------
|
||||||
|
|
||||||
|
toot has an experimental curses based console UI.
|
||||||
|
|
||||||
From APT package repository
|
.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/_static/curses.png
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
This works for Debian, Ubuntu and derivatives.
|
|
||||||
|
|
||||||
The repo is signed with my `keybase.io <https://keybase.io/ihabunek>`_ key.
|
|
||||||
|
|
||||||
Add the `bezdomni.net` repository:
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
echo "deb http://bezdomni.net/packages/ ./" | sudo tee /etc/apt/sources.list.d/bezdomni.list
|
|
||||||
curl https://keybase.io/ihabunek/pgp_keys.asc | sudo apt-key add -
|
|
||||||
|
|
||||||
Install the package:
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
sudo apt update
|
|
||||||
sudo apt install python3-toot
|
|
||||||
|
|
||||||
From FreeBSD ports
|
|
||||||
~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
Install the package:
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
pkg install py36-toot
|
|
||||||
|
|
||||||
Build and install from sources:
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
cd /usr/ports/net-im/toot
|
|
||||||
make install
|
|
||||||
|
|
||||||
FreeBSD port is maintained by `Mateusz Piotrowski <https://mastodon.social/@mpts>`_
|
|
||||||
|
|
||||||
From Nixpkgs
|
|
||||||
~~~~~~~~~~~~
|
|
||||||
|
|
||||||
This works on NixOS or systems with the Nix package manager installed.
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
nix-env -iA nixos.toot
|
|
||||||
|
|
||||||
|
|
||||||
From OpenBSD ports
|
|
||||||
~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
Install the package:
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
pkg_add toot
|
|
||||||
|
|
||||||
Build and install from sources:
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
cd /usr/ports/net/toot
|
|
||||||
make install
|
|
||||||
|
|
||||||
OpenBSD port is maintained by `Klemens Nanni <mailto:kl3@posteo.org>`_
|
|
||||||
|
|
||||||
From Python Package Index
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
Otherwise, install from PyPI using pip, preferably into a virtual environment:
|
|
||||||
|
|
||||||
.. 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.
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
$ toot
|
|
||||||
|
|
||||||
toot - a Mastodon CLI client
|
|
||||||
|
|
||||||
Authentication:
|
|
||||||
toot login Log into a mastodon instance using your browser (recommended)
|
|
||||||
toot login_cli Log in from the console, does NOT support two factor authentication
|
|
||||||
toot activate Switch between logged in accounts.
|
|
||||||
toot logout Log out, delete stored access keys
|
|
||||||
toot auth Show logged in accounts and instances
|
|
||||||
|
|
||||||
Read:
|
|
||||||
toot whoami Display logged in user details
|
|
||||||
toot whois Display account details
|
|
||||||
toot instance Display instance details
|
|
||||||
toot search Search for users or hashtags
|
|
||||||
toot timeline Show recent items in a timeline (home by default)
|
|
||||||
toot curses An experimental timeline app (doesn't work on Windows)
|
|
||||||
|
|
||||||
Post:
|
|
||||||
toot post Post a status text to your timeline
|
|
||||||
toot upload Upload an image or video file
|
|
||||||
toot delete Delete an existing status
|
|
||||||
|
|
||||||
Accounts:
|
|
||||||
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
|
|
||||||
|
|
||||||
To get help for each command run:
|
|
||||||
toot <command> --help
|
|
||||||
|
|
||||||
https://github.com/ihabunek/toot
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
|
|
||||||
Authentication
|
|
||||||
--------------
|
|
||||||
|
|
||||||
Before tooting, you need to login to a Mastodon instance.
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
toot login
|
|
||||||
|
|
||||||
You will be redirected to your Mastodon instance to log in and authorize toot to access your account, and will be given an **authorization code** in return which you need to enter to log in.
|
|
||||||
|
|
||||||
If you don't use two factor authentication you can also log in directly from the command line:
|
|
||||||
|
|
||||||
.. code-block::
|
|
||||||
|
|
||||||
toot login_cli
|
|
||||||
|
|
||||||
You will be asked to chose an instance and enter your credentials.
|
|
||||||
|
|
||||||
The application and user access tokens will be saved in the configuration file located at ``~/.config/toot/instances/config.json``.
|
|
||||||
|
|
||||||
It's possible to be logged into **multiple accounts** at the same time. Just repeat the above process for another instance. You can see all logged in accounts by running ``toot auth``. The currently active account will have an **ACTIVE** flag next to it.
|
|
||||||
|
|
||||||
To switch accounts, use ``toot activate``. Alternatively, most commands accept a ``--using`` option which can be used to specify the account you wish to use just that one time.
|
|
||||||
|
|
||||||
Finally you can logout from an account by using ``toot logout``. This will remove the stored access tokens for that account.
|
|
||||||
|
|
||||||
License
|
License
|
||||||
-------
|
-------
|
||||||
|
|
||||||
Copyright 2017 Ivan Habunek <ivan@habunek.com>
|
Copyright 2018 Ivan Habunek <ivan@habunek.com>
|
||||||
|
|
||||||
Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html
|
Licensed under `GPLv3 <http://www.gnu.org/licenses/gpl-3.0.html>`_, see `LICENSE <LICENSE>`_.
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,17 @@ toot - Mastodon CLI client
|
||||||
|
|
||||||
toot is a commandline tool for interacting with Mastodon social networks.
|
toot is a commandline tool for interacting with Mastodon social networks.
|
||||||
|
|
||||||
Contents:
|
.. 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/MIT
|
||||||
|
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
|
||||||
|
:target: https://pypi.python.org/pypi/toot
|
||||||
|
|
||||||
|
Contents
|
||||||
|
--------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
@ -26,7 +36,7 @@ Features
|
||||||
Curses UI
|
Curses UI
|
||||||
---------
|
---------
|
||||||
|
|
||||||
toot has an experimental curses based console UI.
|
toot has an experimental curses based console UI. Run it with ``toot curses``.
|
||||||
|
|
||||||
.. image :: _static/curses.png
|
.. image :: _static/curses.png
|
||||||
|
|
||||||
|
|
@ -42,6 +52,6 @@ Please report any issues there. Pull requests are welcome.
|
||||||
License
|
License
|
||||||
-------
|
-------
|
||||||
|
|
||||||
Copyright 2017 Ivan Habunek <ivan@habunek.com>
|
Copyright 2018 Ivan Habunek <ivan@habunek.com>
|
||||||
|
|
||||||
Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html
|
Licensed under `GPLv3 <http://www.gnu.org/licenses/gpl-3.0.html>`_.
|
||||||
|
|
|
||||||
|
|
@ -45,18 +45,10 @@ Running ``toot <command> -h`` shows the documentation for the given command.
|
||||||
|
|
||||||
https://github.com/ihabunek/toot
|
https://github.com/ihabunek/toot
|
||||||
|
|
||||||
It is possible to pipe status text into `toot post`, for example:
|
|
||||||
|
|
||||||
.. code-block:: sh
|
|
||||||
|
|
||||||
echo "Text to post" | toot post
|
|
||||||
cat mypost.txt | toot post
|
|
||||||
|
|
||||||
|
|
||||||
Authentication
|
Authentication
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
Before tooting, you need to login to a Mastodon instance.
|
Before tooting, you need to log into a Mastodon instance.
|
||||||
|
|
||||||
.. code-block:: sh
|
.. code-block:: sh
|
||||||
|
|
||||||
|
|
@ -64,18 +56,46 @@ Before tooting, you need to login to a Mastodon instance.
|
||||||
|
|
||||||
You will be redirected to your Mastodon instance to log in and authorize toot to access your account, and will be given an **authorization code** in return which you need to enter to log in.
|
You will be redirected to your Mastodon instance to log in and authorize toot to access your account, and will be given an **authorization code** in return which you need to enter to log in.
|
||||||
|
|
||||||
If you don't use two factor authentication you can also log in directly from the command line:
|
|
||||||
|
|
||||||
.. code-block:: sh
|
|
||||||
|
|
||||||
toot login_cli
|
|
||||||
|
|
||||||
You will be asked to chose an instance and enter your credentials.
|
|
||||||
|
|
||||||
The application and user access tokens will be saved in the configuration file located at ``~/.config/toot/instances/config.json``.
|
The application and user access tokens will be saved in the configuration file located at ``~/.config/toot/instances/config.json``.
|
||||||
|
|
||||||
It's possible to be logged into **multiple accounts** at the same time. Just repeat the above process for another instance. You can see all logged in accounts by running ``toot auth``. The currently active account will have an **ACTIVE** flag next to it.
|
Using multiple accounts
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
It's possible to be logged into **multiple accounts** at the same time. Just repeat the login process for another instance. You can see all logged in accounts by running ``toot auth``. The currently active account will have an **ACTIVE** flag next to it.
|
||||||
|
|
||||||
To switch accounts, use ``toot activate``. Alternatively, most commands accept a ``--using`` option which can be used to specify the account you wish to use just that one time.
|
To switch accounts, use ``toot activate``. Alternatively, most commands accept a ``--using`` option which can be used to specify the account you wish to use just that one time.
|
||||||
|
|
||||||
Finally you can logout from an account by using ``toot logout``. This will remove the stored access tokens for that account.
|
Finally you can logout from an account by using ``toot logout``. This will remove the stored access tokens for that account.
|
||||||
|
|
||||||
|
Examples
|
||||||
|
--------
|
||||||
|
|
||||||
|
Posting
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
The simplest action is posting a status.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
toot post "hello there"
|
||||||
|
|
||||||
|
You can also attach media:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
toot post "hello media" --media path/to/image.png
|
||||||
|
|
||||||
|
If the media is sensitive, mark it as such and people will need to click to show it:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
toot post "naughty pics ahoy" --media nsfw.png --sensitive
|
||||||
|
|
||||||
|
|
||||||
|
It is possible to pipe in the status text:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
echo "Text to post" | toot post
|
||||||
|
cat post.txt | toot post
|
||||||
|
toot post < post.txt
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue