Skip to content

Commit 07c1bf8

Browse files
authored
docs(readme): fix console display and add examples (#7)
* docs(quickstart): add more examples * docs(readme): add link to documentation installation step
1 parent 8759144 commit 07c1bf8

File tree

2 files changed

+73
-11
lines changed

2 files changed

+73
-11
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,8 @@ Relay helps builds create apps on email workflows. See it as a crossover between
5151
### Fetching your unread emails
5252

5353
```shell
54-
relay messages ls --limit 10 --unread
55-
```
56-
```
54+
$ relay messages ls --limit 10 --unread
55+
5756
Using account: piedpiper
5857
Messages from [email protected]
5958
┏━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓
@@ -81,9 +80,8 @@ Showing 5 of 5 unread messages
8180
### Reading email details
8281

8382
```shell
84-
relay messages cat 15443
85-
```
86-
```
83+
$ relay messages cat 15443
84+
8785
Using account: piedpiper
8886

8987
Message Details
@@ -131,7 +129,7 @@ No attachments
131129
132130
- [UV](https://docs.astral.sh/uv/getting-started/installation/)
133131
134-
### 30 seconds setup ⏱️
132+
### 30 seconds setup ⏱️ ([docs](https://docs.relaycli.com/documentation/getting-started/quickstart))
135133
136134
#### 1 - Install the CLI
137135
```shell
@@ -146,7 +144,24 @@ Follow the instructions to connect your email account.
146144
#### 3 - Play with the CLI
147145
148146
```shell
149-
relay messages ls
147+
$ relay messages --help
148+
149+
Usage: relay messages [OPTIONS] COMMAND [ARGS]...
150+
151+
Email message commands
152+
153+
154+
╭─ Options ──────────────────────────────────────────────────────────────────────────────────╮
155+
│ --help Show this message and exit. │
156+
╰────────────────────────────────────────────────────────────────────────────────────────────╯
157+
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────╮
158+
│ list | ls List recent emails from specified account. │
159+
│ open | cat Read a single email message by UID. │
160+
│ search | find | grep Search for messages containing the specified query. │
161+
│ trash | rm Move a message to trash. │
162+
│ spam Mark a message as spam. │
163+
│ mark Mark a message as read or unread. │
164+
╰────────────────────────────────────────────────────────────────────────────────────────────╯
150165
```
151166
152167
## Contributing

docs/documentation/getting-started/quickstart.mdx

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ description: 'From zero to "Hello inbox" in under 5 minutes'
6767
<Tabs>
6868
<Tab title="Fetch recent emails">
6969
```shell
70-
relay messages ls
70+
relay messages ls --unread
7171
```
7272
```
7373
Using account: piedpiper
@@ -87,14 +87,61 @@ description: 'From zero to "Hello inbox" in under 5 minutes'
8787
</Tab>
8888
<Tab title="Search your inbox">
8989
```shell
90-
relay messages grep "Gavin Belson"
90+
relay messages grep "Son of Anton"
91+
```
92+
```console wrap
93+
Using account: piedpiper
94+
No messages found containing 'Son of Anton'
9195
```
9296
</Tab>
9397
<Tab title="Read a specific message">
9498
```shell
95-
relay messages cat 15467
99+
relay messages cat 15443
100+
```
101+
```console wrap expandable
102+
Using account: piedpiper
103+
104+
Message Details
105+
UID: 15443
106+
Timestamp: 2025-06-23 12:35:44 UTC
107+
Subject: Server migration complete
108+
From: "Bertram Gilfoyle" <[email protected]>
109+
110+
111+
BCC: N/A
112+
113+
Message Body:
114+
The migration is done. Obviously.
115+
116+
While you were all probably panicking about downtime (which never happened),
117+
I successfully migrated our entire server infrastructure to the new data center.
118+
119+
Key accomplishments:
120+
- Migrated 47 servers in 3.2 hours
121+
- Implemented redundant failsafes
122+
- Optimized database queries by 340%
123+
- Fixed 23 security vulnerabilities
124+
125+
Richard, the system is now running at 99.97% efficiency. The remaining 0.03%
126+
is due to the laws of physics, which even I cannot override.
127+
128+
Dinesh, I've documented everything in a way that even you might comprehend,
129+
though I make no guarantees.
130+
131+
The servers are purring like a well-fed cat. You may now return to your
132+
regularly scheduled mediocrity.
133+
134+
--
135+
Bertram Gilfoyle
136+
Senior Systems Architect
137+
Pied Piper Inc.
138+
139+
No attachments
96140
```
141+
```shell
142+
relay messages cat 15467
97143
```
144+
```console wrap expandable
98145
Using account: piedpiper
99146

100147
Message Details

0 commit comments

Comments
 (0)