# friendpipe

> Send files to your friends from the command line.

Latest version **0.0.1** (published 2013-08-04) · 0 weekly downloads

## Install

```sh
npm install friendpipe
pnpm add friendpipe
yarn add friendpipe
bun add friendpipe
```

Provides the command `friend`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2013-08-04 |
| First published | 2013-08-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jaz303 |

## Links

- npm: https://www.npmjs.com/package/friendpipe
- npm.io page: https://npm.io/package/friendpipe

## Dependencies (1)

- [docopt](https://npm.io/package/docopt.md) ~0.4.0

## Recent versions

- 0.0.1 (latest) — 2013-08-04

## README

# friendpipe

Send files to your friends from the command line.

Inspired by [@samsquire](https://github.com/samsquire)'s [#86 Friend Pipe](https://github.com/samsquire/ideas#86-friend-pipe).

## Unfinished! The below is just the proposed API.

## Install

    npm install -g friendpipe

## Usage

Let's start by configuring outgoing email:

    friend set smtp.host smtp.example.com
    friend set smtp.port 25
    friend set smtp.sender jason@onehackoranother.com

Next let's add some friends:

    friend add jason mailto:jason@onehackoranother.com
    friend add bob mailto:bob@example.com
    
Now we can send files:

    # send a single file
    friend send foo.jpg jason
    
    # or pipe
    cat foo.jpg | friend send jason bob
    
    # with manual mime type:
    cat kitteh.png | friend send --type=image/png bob
    
    # add a subject line:
    
## Extending

Protocol handlers are implemented in npm modules named according to.

For example, to implement a webdav protocol handler you would call your module `friendpipe-webdav-handler`.

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