8000 improve readme · pimalaya/himalaya@c24879c · GitHub
[go: up one dir, main page]
Skip to content

Commit c24879c

Browse files
soywodsoywod
committed
improve readme
1 parent f8833cc commit c24879c

File tree

1 file changed

+68
-163
lines changed

1 file changed

+68
-163
lines changed

‎README.md

+68-163
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,30 @@ Minimalist CLI email client, written in Rust.
88

99
* [Motivation](#motivation)
1010
* [Installation](#installation)
11+
* [Configuration](#configuration)
1112
* [Usage](#usage)
1213
* [List mailboxes](#list-mailboxes)
13-
* [List emails](#list-emails)
14-
* [Search emails](#search-emails)
15-
* [Download email attachments](#download-email-attachments)
16-
* [Read email](#read-email)
17-
* [Reply email](#reply-email)
18-
* [Forward email](#forward-email)
14+
* [List messages](#list-messages)
15+
* [Search messages](#search-messages)
16+
* [Download attachments](#download-attachments)
17+
* [Read a message](#read-a-message)
18+
* [Write a new message](#write-a-new-message)
19+
* [Reply to a message](#reply-to-a-message)
20+
* [Forward a message](#forward-a-message)
1921
* [License](https://github.com/soywod/himalaya/blob/master/LICENSE)
2022
* [Changelog](https://github.com/soywod/himalaya/blob/master/CHANGELOG.md)
2123
* [Credits](#credits)
2224

2325
## Motivation
2426

25-
Bringing emails to your terminal is a pain. The mainstream TUI, (neo)mutt,
26-
takes time to configure. The default mapping is not intuitive when coming from
27-
the Vim environment. It is even scary to use at the beginning, since you are
27+
Bringing emails to the terminal is a pain. The mainstream TUI, (neo)mutt, takes
28+
time to configure. The default mapping is not intuitive when coming from the
29+
Vim environment. It is even scary to use at the beginning, since you are
2830
dealing with sensitive data!
2931

3032
The aim of Himalaya is to extract the email logic into a simple CLI API that
31-
can be used either directly for the terminal or from various interfaces. It
32-
gives users more flexibility.
33+
can be used either directly from the terminal or from interfaces. It gives
34+
users more flexibility.
3335

3436
## Installation
3537

@@ -46,40 +48,40 @@ more information.*
4648
# ~/.config/himalaya/config.toml
4749

4850
name = "Your full name"
49-
downloads_dir = "/abs/path/to/downloads"
51+
downloads-dir = "/abs/path/to/downloads"
5052

5153
# Himalaya supports the multi-account
5254
# Each account should be inside a TOML section
5355
[gmail]
5456
default = true
5557
email = "my.email@gmail.com"
5658

57-
imap_host = "imap.gmail.com"
58-
imap_port = 993
59-
imap_login = "p.durant@gmail.test.com"
60-
imap_passwd_cmd = "pass show gmail"
59+
imap-host = "imap.gmail.com"
60+
imap-port = 993
61+
imap-login = "test@gmail.com"
62+
imap-passwd_cmd = "pass show gmail"
6163

62-
smtp_host = "smtp.gmail.com"
63-
smtp_port = 487
64-
smtp_login = "p.durant@gmail.test.com"
65-
smtp_passwd_cmd = "pass show gmail"
64+
smtp-host = "smtp.gmail.com"
65+
smtp-port = 487
66+
smtp-login = "test@gmail.com"
67+
smtp-passwd_cmd = "pass show gmail"
6668

6769
[posteo]
6870
name = "Your overriden full name"
69-
downloads_dir = "/abs/path/to/overriden/downloads"
70-
email = "my.email@posteo.net"
71+
downloads-dir = "/abs/path/to/overriden/downloads"
72+
email = "test@posteo.net"
7173

72-
imap_host = "posteo.de"
73-
imap_port = 993
74-
imap_login = "my.email@posteo.net"
75-
imap_passwd_cmd = "security find-internet-password -gs posteo -w"
74+
imap-host = "posteo.de"
75+
imap-port = 993
76+
imap-login = "test@posteo.net"
77+
imap-passwd_cmd = "security find-internet-password -gs posteo -w"
7678

77-
smtp_host = "posteo.de"
78-
smtp_port = 487
79-
smtp_login = "my.email@posteo.net"
80-
smtp_passwd_cmd = "security find-internet-password -gs posteo -w"
79+
smtp-host = "posteo.de"
80+
smtp-port = 487
81+
smtp-login = "test@posteo.net"
82+
smtp-passwd_cmd = "security find-internet-password -gs posteo -w"
8183

82-
# [other account]
84+
# [other accounts]
8385
# ...
8486
```
8587

@@ -101,7 +103,8 @@ FLAGS:
101103
-V, --version Prints version information
102104
103105
OPTIONS:
104-
-a, --account <STRING> Name of the config file to use
106+
-a, --account <STRING> Name of the account to use
107+
-o, --output <STRING> Format of the output to print [default: text] [possible values: text, json]
105108
106109
SUBCOMMANDS:
107110
attachments Downloads all attachments from an email
@@ -111,7 +114,10 @@ SUBCOMMANDS:
111114
mailboxes Lists all available mailboxes
112115
read Reads text bodies of an email
113116
reply Answers to an email
117+
save Saves a raw message in the given mailbox
114118
search Lists emails matching the given IMAP query
119+
send Sends a raw message
120+
template Generates a message template
115121
write Writes a new email
116122
```
117123

@@ -120,182 +126,80 @@ information.*
120126

121127
### List mailboxes
122128

123-
![image](https://user-images.githubusercontent.com/10437171/104848169-0e432000-58e4-11eb-8410-05f0404c0d99.png)
124-
125-
```
126-
himalaya-mailboxes
127-
Lists all available mailboxes
129+
Shows mailboxes in a basic table.
128130

129-
USAGE:
130-
himalaya mailboxes
131-
132-
FLAGS:
133-
-h, --help Prints help information
134-
-V, --version Prints version information
135-
```
131+
![image](https://user-images.githubusercontent.com/10437171/104848169-0e432000-58e4-11eb-8410-05f0404c0d99.png)
136132

137133
*See [wiki section](https://github.com/soywod/himalaya/wiki/Usage:mailboxes)
138134
for more information.*
139135

140-
### List emails
136+
### List messages
141137

142-
![image](https://user-images.githubusercontent.com/10437171/104848096-aee51000-58e3-11eb-8d99-bcfab5ca28ba.png)
138+
Shows messages in a basic table.
143139

144-
```
145-
himalaya-list
146-
Lists emails sorted by arrival date
147-
148-
USAGE:
149-
himalaya list [OPTIONS]
150-
151-
FLAGS:
152-
-h, --help Prints help information
153-
-V, --version Prints version information
154-
155-
OPTIONS:
156-
-m, --mailbox <STRING> Name of the mailbox [default: INBOX]
157-
-p, --page <INT> Page number [default: 0]
158-
-s, --size <INT> Page size [default: 10]
159-
```
140+
![image](https://user-images.githubusercontent.com/10437171/104848096-aee51000-58e3-11eb-8d99-bcfab5ca28ba.png)
160141

161142
*See [wiki section](https://github.com/soywod/himalaya/wiki/Usage:list) for
162143
more information.*
163144

164-
### Search emails
165-
166-
![image](https://user-images.githubusercontent.com/10437171/104848096-aee51000-58e3-11eb-8d99-bcfab5ca28ba.png)
167-
168-
```
169-
himalaya-search
170-
Lists emails matching the given IMAP query
145+
### Search messages
171146

172-
USAGE:
173-
himalaya search [OPTIONS] <QUERY>...
147+
Shows filtered messages in a basic table. The query should follow the
148+
[RFC-3501](https://tools.ietf.org/html/rfc3501#section-6.4.4).
174149

175-
FLAGS:
176-
-h, --help Prints help information
177-
-V, --version Prints version information
178-
179-
OPTIONS:
180-
-m, --mailbox <STRING> Name of the mailbox [default: INBOX]
181-
-p, --page <INT> Page number [default: 0]
182-
-s, --size <INT> Page size [default: 10]
183-
184-
ARGS:
185-
<QUERY>... IMAP query (see https://tools.ietf.org/html/rfc3501#section-6.4.4)
186-
```
150+
![image](https://user-images.githubusercontent.com/10437171/110698977-9d86f880-81ee-11eb-8990-0ca89c7d4640.png)
187151

188152
*See [wiki section](https://github.com/soywod/himalaya/wiki/Usage:search) for
189153
more information.*
190154

191-
### Download email attachments
192-
193-
![image](https://user-images.githubusercontent.com/10437171/104848278-890c3b00-58e4-11eb-9b5c-48807c04f762.png)
194-
195-
```
196-
himalaya-attachments
197-
Downloads all attachments from an email
198-
199-
USAGE:
200-
himalaya attachments [OPTIONS] <UID>
201-
202-
FLAGS:
203-
-h, --help Prints help information
204-
-V, --version Prints version information
155+
### Download attachments
205156

206-
OPTIONS:
207-
-m, --mailbox <STRING> Name of the mailbox [default: INBOX]
157+
Downloads attachments in the [`downloads-dir`](#configuration).
208158

209-
ARGS:
210-
<UID> UID of the email
211-
```
159+
![image](https://user-images.githubusercontent.com/10437171/104848278-890c3b00-58e4-11eb-9b5c-48807c04f762.png)
212160

213161
*See [wiki section](https://github.com/soywod/himalaya/wiki/Usage:attachments)
214162
for more information.*
215163

216-
### Read email
164+
### Read a message
217165

218-
```
219-
himalaya-read
220-
Reads text bodies of an email
166+
Shows the text content of a message (`text/plain` if exists, otherwise
167+
`text/html`).
221168

222-
USAGE:
223-
himalaya read [OPTIONS] <UID>
224-
225-
FLAGS:
226-
-h, --help Prints help information
227-
-V, --version Prints version information
228-
229-
OPTIONS:
230-
-m, --mailbox <STRING> Name of the mailbox [default: INBOX]
231-
-t, --mime-type <STRING> MIME type to use [default: plain] [possible values: plain, html]
232-
233-
ARGS:
234-
<UID> UID of the email
235-
```
169+
![image](https://user-images.githubusercontent.com/10437171/110701369-5d754500-81f1-11eb-932f-94c2ca8db068.png)
236170

237171
*See [wiki section](https://github.com/soywod/himalaya/wiki/Usage:read) for
238172
more information.*
239173

240-
### Write email
241-
242-
```
243-
himalaya-write
244-
Writes a new email
174+
### Write a new message
245175

246-
USAGE:
247-
himalaya write
176+
Opens your default editor (from the `$EDITOR` environment variable) to compose
177+
a new message.
248178

249-
FLAGS:
250-
-h, --help Prints help information
251-
-V, --version Prints version information
179+
```bash
180+
himalaya write
252181
```
253182

254183
*See [wiki section](https://github.com/soywod/himalaya/wiki/Usage:write) for
255184
more information.*
256185

257-
### Reply email
258-
259-
```
260-
himalaya-reply
261-
Answers to an email
186+
### Reply to a message
262187

263-
USAGE:
264-
himalaya reply [FLAGS] [OPTIONS] <UID>
188+
Opens your default editor to reply to a message.
265189

266-
FLAGS:
267-
-h, --help Prints help information
268-
-a, --all Includs all recipients
269-
-V, --version Prints version information
270-
271-
OPTIONS:
272-
-m, --mailbox <STRING> Name of the mailbox [default: INBOX]
273-
274-
ARGS:
275-
<UID> UID of the email
190+
```bash
191+
himalaya reply --all 5123
276192
```
277193

278194
*See [wiki section](https://github.com/soywod/himalaya/wiki/Usage:reply) for
279195
more information.*
280196

281-
### Forward email
197+
### Forward a message
282198

283-
```
284-
himalaya-forward
285-
Forwards an email
286-
287-
USAGE:
288-
himalaya forward [OPTIONS] <UID>
289-
290-
FLAGS:
291-
-h, --help Prints help information
292-
-V, --version Prints version information
199+
Opens your default editor to forward a message.
293200

294-
OPTIONS:
295-
-m, --mailbox <STRING> Name of the mailbox [default: INBOX]
296-
297-
ARGS:
298-
<UID> UID of the email
201+
```bash
202+
himalaya forward 5123
299203
```
300204

301205
*See [wiki section](https://github.com/soywod/himalaya/wiki/Usage:forward) for
@@ -306,5 +210,6 @@ more information.*
306210
- [IMAP RFC3501](https://tools.ietf.org/html/rfc3501)
307211
- [Iris](https://github.com/soywod/iris.vim), the himalaya predecessor
308212
- [Neomutt](https://neomutt.org/)
213+
- [mutt-wizard](https://github.com/LukeSmithxyz/mutt-wizard)
309214
- [Alpine](http://alpine.x10host.com/alpine/alpine-info/)
310215
- [rust-imap](https://github.com/jonhoo/rust-imap)

0 commit comments

Comments
 (0)
0