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 12e4258ae4
conf: add * glob expansion to subscribed_folders field
2 years ago
benches melib: remove BackendOpGenerator 2 years ago
debug_printer Fix warnings, lints, and 2018 errors 2 years ago
melib Display watch thread errors to user 2 years ago
scripts scripts: remove auto-rustfmt from pre-commit hook 3 years ago
src bin: add --test-config flag 2 years ago
testing Remove unused imports from testing/src/ 2 years ago
tests Add tests/ dir and a test 2 years ago
text_processing text_processing: add GlobMatch trait 2 years ago
ui conf: add * glob expansion to subscribed_folders field 2 years ago
.gdbinit small fixes 2 years ago
.gitignore Add Cargo.lock 2 years ago
COPYING mailbox: add threads 3 years ago
Cargo.lock add sqlite3 feature WIP 2 years ago
Cargo.toml Reexport debug-tracing feature from main Cargo.toml 2 years ago
Makefile Small Makefile prettification 2 years ago
README melib: add notmuch backend 2 years ago
meli.1 bin: add --test-config flag 2 years ago
meli.conf.5 update manpages 2 years ago
rustfmt.toml Run rustfmt 3 years ago
sample-config shortcuts tidiness 2 years ago


__/ \__
/ \__/ \__ .
\__/ \__/ \ , _ , _ ___ │ '
/ \__ \__/ │' `│ `┒ .' ` │ │
\__/ \__/ \ │ │ │ |────' │ │
\__/ \__/ │ / `.___, /\__ /
terminal mail user agent {|||)<
/ \

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


meli requires rust 1.34 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

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 with Debian's packaged cargo might require the installation of these
two packages: librust-openssl-sys-dev and librust-libdbus-sys-dev


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

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

# MELI_FEATURES="melib/notmuch_backend" make

or if building directly with cargo, use the flag '--features="melib/notmuch_backend"'.


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

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, ui, meli} (-- --nocapture) (--test test_name)


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