You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Manos Pitsidianakis 30c31c9c90
debian/: move xdg-utils to recommends
3 years ago
benches melib: remove BackendOpGenerator 3 years ago
debian debian/: move xdg-utils to recommends 3 years ago
melib melib/maildir: fix wrong subscription status in folders 3 years ago
scripts Add pre-push git hook 3 years ago
src meli: add invalid flag combo check 3 years ago
testing Remove text_processing 3 years ago
tests Remove ui crate 3 years ago
.gdbinit small fixes 3 years ago
.gitignore Plugins WIP #2 3 years ago
COPYING mailbox: add threads 3 years ago
Cargo.lock Bumb version to 0.5.0 3 years ago
Cargo.toml Add opt-level=z flag for release profile 3 years ago
Makefile Makefile: don't emit timestamps with gzip 3 years ago Convert README to Markdown 3 years ago meli: add cli-docs feature 3 years ago
meli-themes.5 meli-themes.5: split tables into pages 3 years ago
meli.1 Correct mdoc lint warnings 3 years ago
meli.conf.5 ui/conf: replace include macro with m4 include macro 3 years ago
rustfmt.toml Run rustfmt 3 years ago
sample-config ui/conf: replace include macro with m4 include macro 3 years ago


For a quick start, build and install locally:

 PREFIX=~/.local make install

Available subcommands:

  • meli (builds meli with optimizations in $CARGO_TARGET_DIR)
  • install (installs binary in $BINDIR and documentation to $MANDIR)
  • uninstall Secondary subcommands:
  • clean (cleans build artifacts)
  • check-deps (checks dependencies)
  • install-bin (installs binary to $BINDIR)
  • install-doc (installs manpages to $MANDIR)
  • help (prints this information)
  • dist (creates release tarball named meli-VERSION.tar.gz in this directory)
  • deb-dist (builds debian package in the parent directory)
  • distclean (cleans distribution build artifacts)

The Makefile should be portable and not require a specific make version.


After installing meli, see meli(1) and meli.conf(5) for documentation.


meli requires rust 1.39 and rust's package manager, Cargo. Information on how to get it on your system can be found here:

With Cargo available, the project can be built with

make meli

The resulting binary will then be found under target/release/meli


make install

to install the binary and man pages. This requires root, so I suggest you override the default paths and install it in your $HOME:

make PREFIX=$HOME/.local install

See meli(1) and meli.conf(5) for documentation.

You can build and run meli with one command:

cargo run --release

While the project is in early development, meli will only be developed for the linux kernel and respected linux distributions. Support for more UNIX-like OSes is on the roadmap.

Building in Debian

Building with Debian's packaged cargo might require the installation of these two packages: librust-openssl-sys-dev librust-libdbus-sys-dev

A *.deb package can be built with make deb-dist

Building with notmuch

To use the optional notmuch backend feature, you must have libnotmuch installed in your system. In Debian-like systems, install the libnotmuch5 libnotmuch-dev packages.

To build with notmuch support, prepend the environment variable MELI_FEATURES='notmuch' to your make invocation:

MELI_FEATURES="notmuch" make

or if building directly with cargo, use the flag `--features="notmuch"'.

Building with JMAP

To build with JMAP support, prepend the environment variable MELI_FEATURES='jmap' to your make invocation:

MELI_FEATURES="jmap" make

or if building directly with cargo, use the flag `--features="jmap"'.


Development builds can be built and/or run with

cargo build
cargo run

There is a debug/tracing log feature that can be enabled by using the flag --feature debug-tracing after uncommenting the features in Cargo.toml. The logs are printed in stderr, thus you can run meli with a redirection (i.e 2> log)

Code style follows the default rustfmt profile.


meli by default looks for a configuration file in this location: $XDG_CONFIG_HOME/meli/config.toml

You can run meli with arbitrary configuration files by setting the $MELI_CONFIG environment variable to their locations, ie:

MELI_CONFIG=./test_config cargo run


How to run specific tests:

cargo test -p {melib, meli} (-- --nocapture) (--test test_name)


perf record -g target/debug/bin
perf script | stackcollapse-perf | rust-unmangle | flamegraph > perf.svg