pop/README.md

93 lines
2 KiB
Markdown
Raw Normal View History

2023-06-21 21:49:11 +03:00
# Pop
2023-06-14 07:52:36 +03:00
2023-06-21 22:11:55 +03:00
<p>
2023-06-21 23:55:49 +03:00
<img src="https://stuff.charm.sh/pop/pop-header.png" width="500" />
2023-06-21 22:52:13 +03:00
<br />
2023-06-21 22:11:55 +03:00
<a href="https://github.com/charmbracelet/vhs/releases"><img src="https://img.shields.io/github/release/charmbracelet/vhs.svg" alt="Latest Release"></a>
<a href="https://pkg.go.dev/github.com/charmbracelet/vhs?tab=doc"><img src="https://godoc.org/github.com/golang/gddo?status.svg" alt="Go Docs"></a>
<a href="https://github.com/charmbracelet/vhs/actions"><img src="https://github.com/charmbracelet/vhs/workflows/build/badge.svg" alt="Build Status"></a>
</p>
2023-06-14 07:52:36 +03:00
Send emails from your terminal.
2023-06-21 22:23:06 +03:00
<img width="600" src="https://vhs.charm.sh/vhs-5Ci4SK0PHtyZGoccEOvUEB.gif" alt="pop mail text-based client">
2023-06-21 22:11:55 +03:00
## Text-based User Interface
Launch the TUI
```bash
pop
```
2023-06-14 07:52:36 +03:00
## Command Line Interface
```bash
2023-06-21 21:49:11 +03:00
pop < message.md \
--from "me@example.com" \
--to "you@example.com" \
--subject "Hello, world!" \
--attach invoice.pdf
2023-06-14 07:52:36 +03:00
```
2023-06-21 22:23:06 +03:00
<img src="https://vhs.charm.sh/vhs-34Bcki61sHuNlsxfFVLbj4.gif" alt="pop mail command line client">
2023-06-21 22:52:13 +03:00
### Environment
To use `pop`, you will need a `RESEND_API_KEY`. You can grab one from: https://resend.com/api-keys.
2023-06-14 07:52:36 +03:00
## Installation
Use a package manager:
```bash
# macOS
2023-06-21 21:49:11 +03:00
brew install pop
2023-06-14 07:52:36 +03:00
# Arch
2023-06-21 21:49:11 +03:00
yay -S pop
2023-06-14 07:52:36 +03:00
# Nix
2023-06-21 21:49:11 +03:00
nix-env -iA nixpkgs.pop
2023-06-14 07:52:36 +03:00
```
Install with Go:
```sh
2023-06-21 21:49:11 +03:00
go install github.com/charmbracelet/pop@latest
2023-06-14 07:52:36 +03:00
```
2023-06-21 21:49:11 +03:00
Or download a binary from the [releases](https://github.com/charmbracelet/pop/releases).
2023-06-14 07:52:36 +03:00
## License
2023-06-21 21:49:11 +03:00
[MIT](https://github.com/charmbracelet/pop/blob/master/LICENSE)
2023-06-14 07:52:36 +03:00
## Feedback
2023-06-21 21:49:11 +03:00
Wed love to hear your thoughts on this project. Feel free to drop us a note!
* [Twitter](https://twitter.com/charmcli)
* [The Fediverse](https://mastodon.social/@charmcli)
* [Discord](https://charm.sh/chat)
## License
[MIT](https://github.com/charmbracelet/vhs/raw/main/LICENSE)
***
2023-06-14 07:52:36 +03:00
2023-06-21 21:49:11 +03:00
Part of [Charm](https://charm.sh).
2023-06-14 07:52:36 +03:00
2023-06-21 21:49:11 +03:00
<a href="https://charm.sh/">
<img
alt="The Charm logo"
width="400"
src="https://stuff.charm.sh/charm-badge.jpg"
/>
</a>
2023-06-14 07:52:36 +03:00
2023-06-21 21:49:11 +03:00
Charm热爱开源 • Charm loves open source