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

Update README to reflect login command changes

Browse Source
This commit is contained in:
Ivan Habunek 2018-06-25 14:38:02 +02:00
parent 85818db660
commit c484cc49c5
No known key found for this signature in database
GPG Key ID: CDBD63C43A30BB95
1 changed files with 24 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.rst
View File

@ -121,31 +121,32 @@ Running ``toot <command> -h`` shows the documentation for the given command.
toot - a Mastodon CLI client
Authentication:
toot login Log in from the console, does NOT support two factor authentication
toot login_browser Log in using your browser, supports regular and 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 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
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
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
@ -165,23 +166,19 @@ Authentication
Before tooting, you need to login to a Mastodon instance.
If you don't use two factor authentication you can log in directly from the command line:
.. code-block::
toot login
You will be asked to chose an instance_ and enter your credentials.
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 do use **two factor authentication**, you need to log in through your browser:
If you don't use two factor authentication you can also log in directly from the command line:
.. code-block::
toot login_browser
toot login_cli
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.
.. _instance: https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md
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``.