README.rst - toot - Unnamed repository; edit this file 'description' to name the repository.
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) LICENSE
---
README.rst (5034B)
---
1 ============================
2 Toot - a Mastodon CLI client
3 ============================
4
5 Interact with Mastodon social network from the command line.
6
7 .. image:: https://img.shields.io/travis/ihabunek/toot.svg?maxAge=3600&style=flat-square
8 :target: https://travis-ci.org/ihabunek/toot
9 .. image:: https://img.shields.io/badge/author-%40ihabunek-blue.svg?maxAge=3600&style=flat-square
10 :target: https://mastodon.social/@ihabunek
11 .. image:: https://img.shields.io/github/license/ihabunek/toot.svg?maxAge=3600&style=flat-square
12 :target: https://opensource.org/licenses/MIT
13 .. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
14 :target: https://pypi.python.org/pypi/toot
15
16
17 Installation
18 ------------
19
20 From APT package repository
21 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
22
23 This works for Debian, Ubuntu and derivatives.
24
25 The repo is signed with my `keybase.io <https://keybase.io/ihabunek>`_ key.
26
27 Add the `bezdomni.net` repository:
28
29 .. code-block::
30
31 echo "deb http://bezdomni.net/packages/ ./" | sudo tee /etc/apt/sources.list.d/bezdomni.list
32 curl https://keybase.io/ihabunek/pgp_keys.asc | sudo apt-key add -
33
34 Install the package:
35
36 .. code-block::
37
38 sudo apt update
39 sudo apt install python3-toot
40
41 From Nixpkgs
42 ~~~~~~~~~~~~
43
44 This works on NixOS or systems with the Nix package manager installed.
45
46 .. code-block::
47
48 nix-env -iA nixos.toot
49
50
51 From OpenBSD ports
52 ~~~~~~~~~~~~~~~~~~
53
54 Install the package:
55
56 .. code-block::
57
58 pkg_add toot
59
60 Build and install from sources:
61
62 .. code-block::
63
64 cd /usr/ports/net/toot
65 make install
66
67 Thanks to `Klemens Nanni <mailto:kl3@posteo.org>`_ for handling the OpenBSD ports.
68
69 From Python Package Index
70 ~~~~~~~~~~~~~~~~~~~~~~~~~
71
72 Otherwise, install from PyPI using pip, preferably into a virtual environment:
73
74 .. code-block::
75
76 pip install toot
77
78 Usage
79 -----
80
81 Running ``toot`` displays a list of available commands.
82
83 Running ``toot <command> -h`` shows the documentation for the given command.
84
85 .. code-block::
86
87 $ toot
88
89 toot - a Mastodon CLI client
90
91 Authentication:
92 toot login Log in from the console, does NOT support two factor authentication
93 toot login_browser Log in using your browser, supports regular and two factor authentication
94 toot activate Switch between logged in accounts.
95 toot logout Log out, delete stored access keys
96 toot auth Show logged in accounts and instances
97
98 Read:
99 toot whoami Display logged in user details
100 toot whois Display account details
101 toot instance Display instance details
102 toot search Search for users or hashtags
103 toot timeline Show recent items in your public timeline
104 toot curses An experimental timeline app (doesn't work on Windows)
105
106 Post:
107 toot post Post a status text to your timeline
108 toot upload Upload an image or video file
109
110 Accounts:
111 toot follow Follow an account
112 toot unfollow Unfollow an account
113 toot mute Mute an account
114 toot unmute Unmute an account
115 toot block Block an account
116 toot unblock Unblock an account
117
118 To get help for each command run:
119 toot <command> --help
120
121 https://github.com/ihabunek/toot
122
123 It is possible to pipe status text into `toot post`, for example:
124
125 .. code-block::
126
127 echo "Text to post" | toot post
128 cat mypost.txt | toot post
129
130
131 Authentication
132 --------------
133
134 Before tooting, you need to login to a Mastodon instance.
135
136 If you don't use two factor authentication you can log in directly from the command line:
137
138 .. code-block::
139
140 toot login
141
142 You will be asked to chose an instance_ and enter your credentials.
143
144 If you do use **two factor authentication**, you need to log in through your browser:
145
146 .. code-block::
147
148 toot login_browser
149
150 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.
151
152 .. _instance: https://github.com/tootsuite/documentation/blob/master/Using-Mastodon/List-of-Mastodon-instances.md
153
154 The application and user access tokens will be saved in the configuration file located at ``~/.config/toot/instances/config.json``.
155
156 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.
157
158 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.
159
160 Finally you can logout from an account by using ``toot logout``. This will remove the stored access tokens for that account.
161
162 License
163 -------
164
165 Copyright 2017 Ivan Habunek <ivan@habunek.com>
166
167 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html