To install this package, run in Emacs:
M-x package-install RET mastodon RET
mastodon.el is an Emacs client for the AcitivityPub social networks that
implement the Mastodon API. For info see joinmastodon.org.
Clone this repository and add the lisp directory to your load path. Then, require it and go.
(add-to-list 'load-path "/path/to/mastodon.el/lisp") (require 'mastodon)
(use-package mastodon :ensure t)
The minimum Emacs version is now 27.1. But if you are running an older version it shouldn't be very hard to get it working.
MELPA to your archives:
(require 'package) (add-to-list 'package-archives '("melpa" . "http://melpa.org/packages/") t)
Update and install:
M-x package-refresh-contents RET
M-x package-install RET mastodon RET
mastodon-mode will enable Emojify if it is loaded in your Emacs environment, so
there's no need to write your own hook anymore.
emojify-mode is not required.
mastodon-mode can provide a context menu for its keybindings if Discover is
installed. It is not required.
if you have Discover, add the following to your Emacs init configuration:
(require 'mastodon-discover) (with-eval-after-load 'mastodon (mastodon-discover))
(use-package mastodon :ensure t :config (mastodon-discover))
You need to set 2 variables in your init file to get started:
(see their doc strings for details). For example If you want to post toots as "firstname.lastname@example.org", then put this in your init file:
(setq mastodon-instance-url "https://social.instance.org" mastodon-active-user "example_user")
Then restart Emacs and run
M-x mastodon. Make sure you are connected
to internet before you do this. If you have multiple mastodon accounts
you can activate one at a time by changing those two variables and
If you were using mastodon.el before 2FA was implemented and the above steps
do not work, delete the old file specified by
restart Emacs and follow the steps again.
*mastodon-home* buffer in the major mode and displays toots. If your
credentials are not yet saved, you will be prompted for email and password.
The app registration process will take place if your
||Show discover menu of all bindings, if
||Go to next item (toot, notification, user)|
||Go to previous item (toot, notification, user)|
||Go to the next interesting thing that has an action|
||Go to the previous interesting thing that has an action|
||Open federated timeline (1 prefix arg: hide-replies, 2 prefix args: media only)|
||Open home timeline (1 prefix arg: hide-replies)|
||Open local timeline (1 prefix arg: hide-replies, 2 prefix args: media only)|
||Open notifications timeline|
||Open mentions-only notifications timeline|
||Update current timeline|
||Open thread for toot at point|
||Prompt for tag and open its timeline|
||Open author profile of toot at point|
||Open profile of user attached to toot at point|
||View own profile|
||update your profile bio note|
||view instance description for toot at point|
||view followed tags and load a tag timeline|
||view timeline of all followed tags|
||view favouriters of toot at point|
||view boosters of toot at point|
||switch between mastodon buffers|
||report user/toot at point to instances moderators|
||search (posts, users, tags) (NB: only posts you have interacted with)|
||view, create, and delete filters|
||view/accept/reject follow requests|
||view follow suggestions|
||view your favourited toots|
||view bookmarked toots|
||view your scheduled toots|
||Compose a new toot|
||Toggle content warning content|
||Boost toot under
||Favourite toot under
||toggle bookmark of toot at point|
||Reply to toot under
||Vote on poll at point|
||copy url of toot at point|
||play video/gif at point (requires
||edit your toot at point|
||view edits of toot at point|
||(un)pin your toot at point|
||delete your toot at point, and reload current timeline|
||delete and redraft toot at point, preserving reply/CW/visibility|
||(un)follow, (un)mute, (un)block author of toot at point|
||cycle between statuses, statuses without boosts, followers, and following|
||accept/reject follow request|
||clear notification at point|
||Quit mastodon buffer, leave window open|
||Quit mastodon buffer and kill window|
||Quit and kill all mastodon buffers|
||I boosted this toot|
||I favourited this toot|
||I bookmarked this toot|
M-x mastodon-toot (or
t from a mastodon.el buffer) opens a new buffer/window
mastodon-toot minor mode. Enter the contents of your toot
C-c C-c sends the toot.
C-c C-k cancels. Both actions kill the buffer
and window. Further keybindings are displayed in the buffer, and in the following subsection.
Replies preserve visibility status/content warnings, and include boosters by default.
Server's max toot length, and attachment previews, are shown.
You can download and use your instance's custom emoji
The compose buffer uses
text-mode so any configuration you have for that mode
will be enabled. If any of your existing config conflicts with
you can disable it in the
mastodon-toot-mode-hook. For example, the default
value of that hook is as follows:
(add-hook 'mastodon-toot-mode-hook (lambda () (auto-fill-mode -1)))
||Add content warning|
||Change toot visibility|
||Add sensitive media/nsfw flag|
||Remove all attachments|
||Add emoji (if
||Create a poll|
||Set toot language|
Autocompletion of mentions and tags is provided by
completion-at-point-functions (capf) backends.
mastodon-toot--enable-completion is enabled by default. If you want to enable
company-mode in the toot compose buffer, set
mastodon.el used to run its
own native company backends, but these have been removed in favour of capfs.)
If you don’t run
company and want immediate, keyless completion, you’ll need
to have another completion engine running that handles capfs. A common
mastodon-toot--save-draft: save the current toot as a draft.
mastodon-toot--open-draft-toot: Open a compose buffer and insert one of your draft toots.
mastodon-toot--delete-draft-toot: Delete a draft toot.
mastodon-toot--delete-all-drafts: Delete all your drafts.
In addition to
mastodon, the following three functions are autoloaded and should
work without first loading
mastodon-toot: Compose new toot
mastodon-notifications-get: View all notifications
mastodon-url-lookup: Attempt to load a URL in
mastodon.el. URL may be at point or provided in the minibuffer.
mastodon-tl--view-instance-description: View information about the instance that the author of the toot at point is on.
mastodon-tl--view-own-instance: View information about your own instance.
mastodon-search--trending-tags: View a list of trending hashtags on your instance.
mastodon-search--trending-statuses: View a list of trending statuses on your instance.
mastodon-tl--add-toot-account-at-point-to-list: Add the account of the toot at point to a list.
mastodon-tl--dm-user: Send a direct message to one of the users at point.
mastodon-profile--add-private-note-to-account: Add a private note to another user’s account.
mastodon-profile--view-account-private-note: View a private note on a user’s account.
mastodon-profile--show-familiar-followers: Show a list of “familiar followers” for a given account. Familiar followers are accounts that you follow, and that follow the account.
mastodon-tl--follow-tag: Follow a tag (works like following a user)
mastodon-tl--unfollow-tag: Unfollow a tag
mastodon-tl--list-followed-tags: View a list of tags you're following.
mastodon-tl--followed-tags-timeline: View a timeline of all your followed tags.
mastodon-tl--some-followed-tags-timleine: View a timeline of multiple tags, from your followed tags or any other.
mastodon-switch-to-buffer: switch between mastodon buffers.
mastodon-profile--update-display-name: Update the display name for your account.
mastodon-profile--update-user-profile-note: Update your bio note.
mastodon-profile--update-meta-fields: Update your metadata fields.
mastodon-profile--set-default-toot-visibility: Set the default visibility for your toots.
mastodon-profile--account-locked-toggle: Toggle the locked status of your account. Locked accounts have to manually approve follow requests.
mastodon-profile--account-discoverable-toggle: Toggle the discoverable status of your account. Non-discoverable accounts are not listed in the profile directory.
mastodon-profile--account-bot-toggle: Toggle whether your account is flagged as a bot.
mastodon-profile--account-sensitive-toggle: Toggle whether your posts are marked as sensitive (nsfw) by default.
M-x customize-group RET mastodon to view all customize options.
An index of all user-facing commands and custom variables is available here: mastodon-index.org.
The incomparable Nicholas Rougier has written an alternative timeline layout
The repo is at mastodon-alt.
(code taken from mastodon-future.)
Works for federated, local, and home timelines and for notifications. It's a
little touchy, one thing to avoid is trying to load a timeline more than once
at a time. It can go off the rails a bit, but it's still pretty cool. The
current maintainer of
mastodon.el is unable to debug or improve this feature.
To enable, it, add
(require 'mastodon-async) to your
init.el. Then you can
view a timeline with one of the commands that begin with
You could easily modify the simple function to use your Emacs translator of
go-translate, etc.), you just
need to fetch the toot's content with
(mastodon-tl--content toot) and pass it
to your translator function as its text argument. Here's what
mastodon-toot--translate-toot-text looks like:
(defun mastodon-toot--translate-toot-text () "Translate text of toot at point. Uses `lingva.el'." (interactive) (let* ((toot (mastodon-tl--property 'toot-json))) (if toot (lingva-translate nil (mastodon-tl--content toot)) (message "No toot to translate?"))))
mastodon.el doesn’t currently implement its own bookmark record and handler,
which means that emacs bookmarks will not work as is. Until we implement them,
you can get bookmarks going immediately by using bookmark+.el.
Hard dependencies (should all install with
request(for uploading attachments), emacs-request
persistfor storing some settings across sessions
Optional dependencies (install yourself,
mastodon.el can use them):
emojifyfor inserting and viewing emojis
mpv.elfor viewing videos and gifs
lingva.elfor translating toots
mastodon.el should work with ActivityPub servers that implement the Mastodon API.
Apart from Mastodon itself, it is currently known to work with Pleroma and
Gotosocial. If you attempt to use
mastodon.el with another server that
implements the Mastodon API and run into problems, feel free to open an issue.
PRs, issues, feature requests, and general feedback are very welcome!
mastodon.elhas bugs, as well as lots of room for improvement.
mastodon.elin emacs with no init file (i.e.
emacs -q(instructions and code for doing this are here) to see if it also happens independently of your own config (it probably does).
toggle-debug-on-error), make the bug happen again, and copy the backtrace that appears.
--) between file namespaces and function names, which contradicts normal Elisp style. This needs to be respected until the whole library is changed.
aggressive-indent-modeor similar to keep your code indented.
If you'd like to support continued development of
mastodon.el, I accept
donations via paypal: paypal.me/martianh. If you would
prefer a different payment method, write to me at that address and I can
provide IBAN or other details.
I don't have a tech worker's income, so even a small tip would help out.