# horseshoe-cli

> Command line interface for horseshoe mailer.

Latest version **0.0.0** (published 2014-02-25) · 0 weekly downloads

## Install

```sh
npm install horseshoe-cli
pnpm add horseshoe-cli
yarn add horseshoe-cli
bun add horseshoe-cli
```

Provides the command `horseshoe`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2014-02-25 |
| First published | 2014-02-25 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.x |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lupo Montero |
| Maintainers | lupomontero |
| Keywords | horseshoe, mail, handlebars, nodemailer |

## Links

- npm: https://www.npmjs.com/package/horseshoe-cli
- Repository: https://github.com/lupomontero/horseshoe-cli
- Issues: http://github.com/lupomontero/horseshoe-cli/issues
- npm.io page: https://npm.io/package/horseshoe-cli

## Dependencies (5)

- [nopt](https://npm.io/package/nopt.md) ~2.2.0
- [colors](https://npm.io/package/colors.md) ~0.6.2
- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [horseshoe](https://npm.io/package/horseshoe.md) 0.0.5
- [JSONStream](https://npm.io/package/JSONStream.md) ~0.8.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.0.0 (latest) — 2014-02-25

## README

# [horseshoe](https://github.com/lupomontero/horseshoe) command line interface

[![NPM](https://nodei.co/npm/horseshoe-cli.png?compact=true)](https://nodei.co/npm/horseshoe-cli/)

[![Build Status](https://secure.travis-ci.org/lupomontero/horseshoe-cli.png)](http://travis-ci.org/lupomontero/horseshoe-cli) 
[![Dependency Status](https://david-dm.org/lupomontero/horseshoe-cli.png)](https://david-dm.org/lupomontero/horseshoe-cli)
[![devDependency Status](https://david-dm.org/lupomontero/horseshoe-cli/dev-status.png)](https://david-dm.org/lupomontero/horseshoe-cli#info=devDependencies)

```
➜  horseshoe -h

Usage:

horseshoe [ <options> ] <email1> [ <email2> ... ]

Options:

-s  --subject     The message subject.
-x  --text        The plain text message body.
-m  --html        HTML content.
-t  --tmpl        Handlebars template.
-p  --tmplPath    Path to Handlebars template files.
-d  --data        Data to be used as context for Handlebars template.
-c  --conf        Path to config file. Default is $HOME/.horseshoe.json
-j  --json        Output in JSON format.
-n  --no-colors   Dont do output colouring.
-h  --help        Show this screen you are looking at.
-v  --version     Show horseshoe's version number.

Examples:

1. Send plain text email using options:

horseshoe -s "the subject" -x "simple text body" you@example.com

2. Send plain text email piping body into horseshoe:

echo "the body" | horseshoe -s "the subject" you@example.com

3. Send email using template passing data as argument:

horseshoe -s "the subject" -t "foo" -d '{"name":"Lupo"}' you@example.com

4. Pipe a JSON object with data to render template:

echo '{"name":"Lupo"}' | horseshoe -s "the subject" -t foo you@example.com

5. Pipe a JSON array of messages into horseshoe's stdin:

(Assume each message object has the following properties: to, subject,
and either template and data or text or html)

cat messages.json | horseshoe
```

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/lupomontero/horseshoe-cli/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

---
_Source: https://npm.io/package/horseshoe-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._