lei(1) - f36

1LEI(1)                     public-inbox user manual                     LEI(1)
2
3
4

NAME

6       lei - local email interface
7

SYNOPSIS

9       lei [OPTIONS] COMMAND
10

DESCRIPTION

12       lei is a command-line tool for importing and searching email,
13       regardless of whether it is from a personal mailbox or a public-inbox.
14       lei supports a local, writable store built on top of
15       public-inbox-v2-format(5) and public-inbox-extindex(1).  lei-q(1)
16       provides an interface for querying messages across the lei store and
17       read-only local and remote "externals" (inboxes and external indices).
18
19       Warning: lei is still in its early stages and may destroy mail.  Be
20       sure to have backups of destinations lei writes to.
21
22       Available in public-inbox 1.7.0+.
23

OPTIONS

25       -c NAME=VALUE
26           Override configuration "NAME" to "VALUE".
27
28       -C DIR
29           Change current working directory to the specified directory before
30           running the command.  This option can be given before or after
31           "COMMAND" and is accepted by all lei subcommands except
32           lei-daemon-kill(1).
33

COMMANDS

35       Subcommands for initializing and managing local, writable storage:
36
37       •   lei-init(1)
38
39       •   lei-import(1)
40
41       •   lei-tag(1)
42
43       The following subcommands can be used to manage and inspect external
44       locations:
45
46       •   lei-add-external(1)
47
48       •   lei-forget-external(1)
49
50       •   lei-ls-external(1)
51
52       Subcommands related to searching and inspecting messages from the lei
53       store and configured externals are
54
55       •   lei-blob(1)
56
57       •   lei-config(1)
58
59       •   lei-edit-search(1)
60
61       •   lei-forget-search(1)
62
63       •   lei-lcat(1)
64
65       •   lei-ls-search(1)
66
67       •   lei-p2q(1)
68
69       •   lei-q(1)
70
71       •   lei-rediff(1)
72
73       •   lei-up(1)
74
75       Other subcommands include
76
77       •   lei-add-watch(1)
78
79       •   lei-config(1)
80
81       •   lei-convert(1)
82
83       •   lei-daemon-kill(1)
84
85       •   lei-daemon-pid(1)
86
87       •   lei-forget-mail-sync(1)
88
89       •   lei-mail-diff(1)
90
91       •   lei-inspect(1)
92
93       •   lei-ls-label(1)
94
95       •   lei-ls-mail-source(1)
96
97       •   lei-ls-mail-sync(1)
98
99       •   lei-ls-watch(1)
100
101       •   lei-rm-watch(1)
102

FILES

104       By default storage is located at "$XDG_DATA_HOME/lei/store".  The
105       configuration for lei resides at "$XDG_CONFIG_HOME/lei/config".
106

ERRORS

108       Errors and dianostics for interactive commands are reported to stderr.
109       Some errors for background tasks are emitted via syslog(3) as
110       lei-daemon(8) for the top-level daemon, and "lei/store" for the
111       lei-store-format(5) worker.
112

CONTACT

114       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
115
116       The mail archives are hosted at <https://public-inbox.org/meta/> and
117       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
118

COPYRIGHT

120       Copyright all contributors <mailto:meta@public-inbox.org>
121
122       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
123