3 lei - local email interface
11 lei is a command-line tool for importing and searching email,
12 regardless of whether it is from a personal mailbox or a public-inbox.
13 lei supports a local, writable store built on top of
14 L<public-inbox-v2-format(5)> and L<public-inbox-extindex(1)>.
15 L<lei-q(1)> provides an interface for querying messages across the lei
16 store and read-only local and remote "externals" (inboxes and external
19 Warning: lei is still in its early stages and may destroy mail.
20 Be sure to have backups of destinations lei writes to.
22 Available in public-inbox 1.7.0+.
30 Override configuration C<NAME> to C<VALUE>.
34 Change current working directory to the specified directory before
35 running the command. This option can be given before or after
36 C<COMMAND> and is accepted by all lei subcommands except
37 L<lei-daemon-kill(1)>.
43 Subcommands for initializing and managing local, writable storage:
47 =item * L<lei-init(1)>
49 =item * L<lei-import(1)>
55 The following subcommands can be used to manage and inspect external
60 =item * L<lei-add-external(1)>
62 =item * L<lei-forget-external(1)>
64 =item * L<lei-ls-external(1)>
68 Subcommands related to searching and inspecting messages from the lei
69 store and configured externals are
73 =item * L<lei-blob(1)>
75 =item * L<lei-config(1)>
77 =item * L<lei-edit-search(1)>
79 =item * L<lei-forget-search(1)>
81 =item * L<lei-lcat(1)>
83 =item * L<lei-ls-search(1)>
89 =item * L<lei-rediff(1)>
95 Other subcommands include
99 =item * L<lei-add-watch(1)>
101 =item * L<lei-config(1)>
103 =item * L<lei-convert(1)>
105 =item * L<lei-daemon-kill(1)>
107 =item * L<lei-daemon-pid(1)>
109 =item * L<lei-forget-mail-sync(1)>
111 =item * L<lei-mail-diff(1)>
113 =item * L<lei-inspect(1)>
115 =item * L<lei-ls-label(1)>
117 =item * L<lei-ls-mail-source(1)>
119 =item * L<lei-ls-mail-sync(1)>
121 =item * L<lei-ls-watch(1)>
123 =item * L<lei-rm-watch(1)>
129 By default storage is located at C<$XDG_DATA_HOME/lei/store>. The
130 configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>.
134 Errors and dianostics for interactive commands are reported to
135 stderr. Some errors for background tasks are emitted via
136 L<syslog(3)> as L<lei-daemon(8)> for the top-level daemon,
137 and C<lei/store> for the L<lei-store-format(5)> worker.
141 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
143 The mail archives are hosted at L<https://public-inbox.org/meta/> and
144 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
148 Copyright all contributors L<mailto:meta@public-inbox.org>
150 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
154 L<lei-overview(7)>, L<lei-daemon(8)>