Emacs client for Mastodon
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)Or, with use-package:
(use-package mastodon
:ensure t)Add 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))Or, with use-package:
(use-package mastodon
:ensure t
:config
(mastodon-discover))2FA is not supported yet. It is in the plans for the 1.0.0 release.
If you have 2FA enabled and try to use mastodon.el, your Emacs client will hang until you `C-g` your way out.
Set mastodon-instance-url in your .emacs or customize. Defaults to the flagship.
(setq mastodon-instance-url "https://my.instance.url")There is an option to have your user credentials (email address and password) saved to disk so you don’t have to re-enter them on every restart.
The default is not to do this because if not properly configured it would save these unencrypted which is not a good default to have.
Customize the variable mastodon-auth-source-file if you want to enable this feature.
M-x mastodon
Opens a *mastodon-home* buffer in the major mode so you can see toots. You will be prompted for email and password. The app registration process will take place if your mastodon-token-file does not contain :client_id and :client_secret.
| Key | Action |
|---|---|
| Help | |
? | Open context menu if discover is available |
| Timeline actions | |
n | Go to next item (toot, notification) |
p | Go to previous item (toot, notification) |
M-n=/=<tab> | Go to the next interesting thing that has an action |
M-p=/=<S-tab> | Go to the previous interesting thing that has an action |
u | Update timeline |
# | Prompt for tag and open its timeline |
A | Open author profile of toot under point |
F | Open federated timeline |
H | Open home timeline |
L | Open local timeline |
N | Open notifications timeline |
P | Open profile of user attached to toot under point |
T | Open thread buffer for toot under point |
| Toot actions | |
c | Toggle content warning content |
b | Boost toot under point |
f | Favourite toot under point |
r | Reply to toot under point |
n | Compose a new toot |
| Switching to other buffers | |
| Quitting | |
q | Quit mastodon buffer, leave window open |
Q | Quit mastodon buffer and kill window |
| Marker | Meaning |
|---|---|
(B) | I boosted this toot. |
(F) | I favourited this toot. |
M-x mastodon-toot
Pops a new buffer/window with a mastodon-toot minor mode. Enter the
contents of your toot here. C-c C-c sends the toot. C-c C-k cancels.
Both actions kill the buffer and window.
If you have not previously authenticated, you will be prompted for your account email and password. NOTE: Email and password are NOT stored by mastodon.el.
Authentication stores your access token in the mastodon-auth--token
variable. It is not stored on your filesystem, so you will have to
re-authenticate when you close/reopen Emacs.
The default toot visibility can be changed by setting or customizing the mastodon-toot--default-visibility variable. Valid values are "public", "unlisted", "private", or direct.
Toot visibility can also be changed on a per-toot basis from the new toot buffer.
| Key | Action |
|---|---|
C-c C-c | Send toot |
C-c C-k | Cancel toot |
C-c C-w | Add content warning |
C-c C-v | Change toot visibility |
Here are the features I plan to implement before putting mastodon.el on MELPA.
Here are the plans I have for the 1.0.0 release.
PRs, issues, and feature requests are very welcome!
- Create an issue detailing the feature you’d like to add.
- Fork the repository and create a branch off of
develop. - Create a pull request referencing the issue created in step 1.
- In an issue, let me know that you’re working to fix it.
- Fork the repository and create a branch off of
develop. - Create a pull request referencing the issue from step 1.
If you want to get in touch with me, give me a toot or leave an issue.