Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 23 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,8 @@ Relay helps builds create apps on email workflows. See it as a crossover between
### Fetching your unread emails

```shell
relay messages ls --limit 10 --unread
```
```
$ relay messages ls --limit 10 --unread

Using account: piedpiper
Messages from [email protected]
┏━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓
Expand Down Expand Up @@ -81,9 +80,8 @@ Showing 5 of 5 unread messages
### Reading email details

```shell
relay messages cat 15443
```
```
$ relay messages cat 15443

Using account: piedpiper

Message Details
Expand Down Expand Up @@ -131,7 +129,7 @@ No attachments

- [UV](https://docs.astral.sh/uv/getting-started/installation/)

### 30 seconds setup ⏱️
### 30 seconds setup ⏱️ ([docs](https://docs.relaycli.com/documentation/getting-started/quickstart))

#### 1 - Install the CLI
```shell
Expand All @@ -146,7 +144,24 @@ Follow the instructions to connect your email account.
#### 3 - Play with the CLI

```shell
relay messages ls
$ relay messages --help

Usage: relay messages [OPTIONS] COMMAND [ARGS]...

Email message commands


╭─ Options ──────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────╮
│ list | ls List recent emails from specified account. │
│ open | cat Read a single email message by UID. │
│ search | find | grep Search for messages containing the specified query. │
│ trash | rm Move a message to trash. │
│ spam Mark a message as spam. │
│ mark Mark a message as read or unread. │
╰────────────────────────────────────────────────────────────────────────────────────────────╯
```

## Contributing
Expand Down
53 changes: 50 additions & 3 deletions docs/documentation/getting-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ description: 'From zero to "Hello inbox" in under 5 minutes'
<Tabs>
<Tab title="Fetch recent emails">
```shell
relay messages ls
relay messages ls --unread
```
```
Using account: piedpiper
Expand All @@ -87,14 +87,61 @@ description: 'From zero to "Hello inbox" in under 5 minutes'
</Tab>
<Tab title="Search your inbox">
```shell
relay messages grep "Gavin Belson"
relay messages grep "Son of Anton"
```
```console wrap
Using account: piedpiper
No messages found containing 'Son of Anton'
```
</Tab>
<Tab title="Read a specific message">
```shell
relay messages cat 15467
relay messages cat 15443
```
```console wrap expandable
Using account: piedpiper

Message Details
UID: 15443
Timestamp: 2025-06-23 12:35:44 UTC
Subject: Server migration complete
From: "Bertram Gilfoyle" <[email protected]>
To: [email protected]
CC: [email protected], [email protected]
BCC: N/A

Message Body:
The migration is done. Obviously.

While you were all probably panicking about downtime (which never happened),
I successfully migrated our entire server infrastructure to the new data center.

Key accomplishments:
- Migrated 47 servers in 3.2 hours
- Implemented redundant failsafes
- Optimized database queries by 340%
- Fixed 23 security vulnerabilities

Richard, the system is now running at 99.97% efficiency. The remaining 0.03%
is due to the laws of physics, which even I cannot override.

Dinesh, I've documented everything in a way that even you might comprehend,
though I make no guarantees.

The servers are purring like a well-fed cat. You may now return to your
regularly scheduled mediocrity.

--
Bertram Gilfoyle
Senior Systems Architect
Pied Piper Inc.

No attachments
```
```shell
relay messages cat 15467
```
```console wrap expandable
Using account: piedpiper

Message Details
Expand Down