Skip to content
Branch: master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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
  :ensure t)

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 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))

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")

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.

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
Help
?Open context menu if discover is available
Timeline actions
nGo to next item (toot, notification)
pGo 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
uUpdate timeline
#Prompt for tag and open its timeline
AOpen author profile of toot under point
FOpen federated timeline
HOpen home timeline
LOpen local timeline
NOpen notifications timeline
POpen profile of user attached to toot under point
TOpen thread buffer for toot under point
Toot actions
cToggle content warning content
bBoost toot under point
fFavourite toot under point
rReply to toot under point
nCompose a new toot
Switching to other buffers
Quitting
qQuit mastodon buffer, leave window open
QQuit mastodon buffer and kill window

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.

Customization

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.

Keybindings

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

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.

You can’t perform that action at this time.