Astroid is a Mail User Agent. As such, all Astroid provides is a graphical interface to your email. Thus, Astroid enables you to launch actions that rely on the performance of other programs to actually fetch, sync, index, search and send your email. A suggested setup is described in the wiki.
Check out the tour of how to install, configure and use astroid. Brief instructions are provided below.
- lightweight and fast!
- fully operatable by keyboard.
- graphical interface, inspired by sup. but allow buffers to be separeted and placed in several windows.
- allow several simultaneous windows.
- display html mail and some attachments inline.
- render math using MathJax
- syntax highlighting between triple-backtick tags (markdown style)
- themable and configurable
- built-in crypto (PGP/MIME) support.
- editors: embed vim or emacs (or anything else that supports XEmbed)
- python og lua plugins.
- and more...
get astroid from:
$ git clone https://github.com/gauteh/astroid.git
$ scons
to run the tests do:
$ scons test
Configure with a prefix and install:
$ scons --prefix=/usr build
$ scons --prefix=/usr install
this will install the astroid binary into /usr/bin/ and data files into /usr/share/astroid/. refer to the installing section in the wiki for more information.
running astroid will make a new configuration file in $XDG_CONFIG_HOME/astroid (normally: ~/.config/astroid/. refer to the configuration section in the wiki for more information.
$ ./astroid
press ? to get a list of available key bindings in the current mode, navigate up and down using j and k. refer to the usage section in the wiki for more information on usage and customization.
Report on the github page or to the mailinglist at: [email protected], subscribe online or by sending an email to: [email protected].
Contributions to Astroid in the form of patches, documentation and testing are very welcome. Information on how to contribute to astroid can be found in the wiki.
You can usually find us at #astroid (web) or #notmuch (web) at irc.freenode.net.
The main inspiration for astroid is the sup mail user agent. sup provided inspiration for notmuch which is a mail indexer. astroid is using notmuch as a backend.
Some parts of the user interface and layout have been copied from or has been inspired by the Geary mail client. Also, some inspiration and code stems from ner, another notmuch email client.
See LICENSE.md for licensing information.