aniani/toot
1
0
Fork 0
mirror of https://github.com/ihabunek/toot.git synced 2024-12-04 14:46:33 -05:00
Code

Add usage examples to docs

Browse Source
This commit is contained in:
Ivan Habunek 2019-02-15 13:40:05 +01:00
parent 10595be865
commit d46c820f52
No known key found for this signature in database
GPG Key ID: CDBD63C43A30BB95
1 changed files with 111 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

146
docs/usage.rst
View File

@ -13,40 +13,42 @@ Running ``toot <command> -h`` shows the documentation for the given command.
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
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)
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 thread Show toot thread items
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 post Post a status text to your timeline
toot upload Upload an image or video file
Status:
toot delete Delete a status
toot favourite Favourite a status
toot unfavourite Unfavourite a status
toot reblog Reblog a status
toot unreblog Unreblog a status
toot pin Pin a status
toot unpin Unpin a status
toot delete Delete a status
toot favourite Favourite a status
toot unfavourite Unfavourite a status
toot reblog Reblog a status
toot unreblog Unreblog a status
toot reblogged_by Show accounts that reblogged the status
toot pin Pin a status
toot unpin Unpin a 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
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
@ -62,24 +64,33 @@ Before tooting, you need to log into a Mastodon instance.
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.
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.
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``.
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.
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
~~~~~~~
Post
~~~~
The simplest action is posting a status.
@ -93,7 +104,8 @@ You can also attach media:
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:
If the media is sensitive, mark it as such and people will need to click to show
it:
.. code-block:: bash
@ -109,8 +121,70 @@ It is possible to pipe in the status text:
toot post < post.txt
View timeline
~~~~~~~~~~~~~
View what's on your home timeline:
.. code-block:: bash
toot timeline
Timeline takes various options:
.. code-block:: bash
toot timeline --public # public timeline
toot timeline --public --local # public timeline, only this instance
toot timeline --tag photo # posts tagged with #photo
toot timeline --count 5 # fetch 5 toots (max 20)
toot timeline --once # don't promopt to fetch more toots
Status actions
~~~~~~~~~~~~~~
The timeline lists the status ID at the bottom of each toot. Using that status
you can do various actions to it, e.g.:
.. code-block:: bash
toot favourite 123456
toot reblog 123456
If it's your own status you can also delete pin or delete it:
.. code-block:: bash
toot pin 123456
toot delete 123456
Account actions
~~~~~~~~~~~~~~~
Find a user by their name or account name:
.. code-block:: bash
toot search "name surname"
toot search @someone
toot search someone@someplace.social
Once found, follow them:
.. code-block:: bash
toot follow someone@someplace.social
If you get bored of them:
.. code-block:: bash
toot mute someone@someplace.social
toot block someone@someplace.social
toot unfollow someone@someplace.social
Using the Curses UI
~~~~~~~
~~~~~~~~~~~~~~~~~~~
toot has an expimental curses based console UI. The command to start it is ``toot curses``.
@ -120,6 +194,8 @@ To navigate the UI use these commands:
* ``j`` or ``down arrow`` to move down the list of tweets
* ``h`` to show a help screen
* ``v`` to view the current toot in a browser (this is great for seeing the comment thread on a toot)
* ``b`` to boost or unboost a status
* ``f`` to favourite or unfavourite a status
* ``q`` to quit the curses interface and return to the command line
* ``s`` to show sensitive content. (This is per-toot, and there will be a read bar in the toot to indicate that it is there.)