Emacs client for Mastodon
Emacs Lisp
Clone or download
jdenen Merge pull request #173 from jdenen/develop
Merge 0.7.2 into master
Latest commit ae8dabd Mar 6, 2018

README.org

mastodon.el

https://melpa.org/packages/mastodon-badge.svg

https://travis-ci.org/jdenen/mastodon.el.svg?branch=master https://badge.waffle.io/jdenen/mastodon.el.png?label=in%20progress&title=In%20Progress

Emacs client for Mastodon

https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg

Installation

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
  :load-path "/path/to/mastodon.el/lisp")

MELPA

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

Emoji

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.

Discover

mastodon-mode will provide a context menu for its keybindings if Discover is installed. It is not required.

Usage

2 Factor Auth

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.

Instance

Set mastodon-instance-url in your .emacs or customize. Defaults to the flagship.

(setq mastodon-instance-url "https://my.instance.url")

Timelines

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.

Keybindings

KeyAction
?Open context menu (if discover is available)
bBoost toot under point
fFavourite toot under point
FOpen federated timeline
HOpen home timeline
jGo to next toot
kGo to previous toot
LOpen local timeline
nSwitch to mastodon-toot buffer
qQuit mastodon buffer. Leave window open.
QQuit mastodon buffer and kill window.
rReply to toot under point.
tOpen thread buffer for toot under point.
TPrompt for tag and open its timeline
<tab>Go to the next interesting thing that has an action.
<S-tab>Go to the previous interesting thing that has an action.
<return> / <mouse-2>Perform action for the thing under point (or under mouse for <mouse-2>) if any.

Legend

MarkerMeaning
(B)I boosted this toot.
(F)I favourited this toot.

Toot 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.

Keybindings

KeyAction
C-c C-cSend toot
C-c C-kCancel toot
C-c C-wAdd content warning

Roadmap

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.

Contributing

PRs, issues, and feature requests are very welcome!

Features

  1. Create an issue detailing the feature you’d like to add.
  2. Fork the repository and create a branch off of develop.
  3. Create a pull request referencing the issue created in step 1.

Fixes

  1. In an issue, let me know that you’re working to fix it.
  2. Fork the repository and create a branch off of develop.
  3. Create a pull request referencing the issue from step 1.

Connect

If you want to get in touch with me, give me a toot or leave an issue.