# piche

> A localtunnel based pipe tool to share text quickly from terminal

Latest version **1.2.0** (published 2019-06-08) · MIT license · 0 weekly downloads

## Install

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

Provides the command `piche`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2019-06-08 |
| First published | 2019-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 9 |
| Unpacked size | 27.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | louisgv |

## Links

- npm: https://www.npmjs.com/package/piche
- Repository: https://gitlab.com/louisgv/piche
- Homepage: https://gitlab.com/louisgv/piche#readme
- Issues: https://gitlab.com/louisgv/piche/issues
- npm.io page: https://npm.io/package/piche

## Dependencies (9)

- [ink](https://npm.io/package/ink.md) ^2.2.0
- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [react](https://npm.io/package/react.md) ^16.8.6
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.0.1
- [pasteljs](https://npm.io/package/pasteljs.md) ^1.0.2
- [clipboardy](https://npm.io/package/clipboardy.md) ^2.0.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [localtunnel](https://npm.io/package/localtunnel.md) ^1.9.2
- [serve-handler](https://npm.io/package/serve-handler.md) ^6.0.1

## Recent versions

- 1.2.0 (latest) — 2019-06-08
- 1.1.0 — 2019-06-07
- 1.0.0 — 2019-06-07
- 0.1.0 — 2019-06-07
- 0.0.0 — 2019-06-06

## README

# piche

> UwU A localtunnel based pipe tool to share text quickly from terminal. Created with [create-pastel-app](https://github.com/vadimdemedes/create-pastel-app), inspired by
[fiche](https://github.com/solusipse/fiche).

Made in roughly 9 hours with the help of the following awesome libraries:

- [clipboardy](https://github.com/sindresorhus/clipboardy)
- [fs-extra](https://github.com/jprichardson/node-fs-extra)
- [ink](https://github.com/vadimdemedes/ink)
- [localtunnel](https://github.com/localtunnel/localtunnel)
- [pasteljs](https://github.com/vadimdemedes/pastel)
- [prop-types](https://github.com/facebook/prop-types)
- [react](https://github.com/facebook/react)
- [serve-handler](https://github.com/zeit/serve-handler)
- [uuid](https://github.com/kelektiv/node-uuid)

## Zero-install Usage

> UvU You will need [nodejs >= 10](https://nodejs.org/en/)

### Start piche local tunnel:

```bash
npx piche -s
```

### (Optionally) Piche local temp tunnel:

```bash
npx piche -st
```

> piche will cleanup all the data piped on SIGINT.

### Pipe data to piche and share it with other:

```bash
echo hello world | npx piche
```

### (Optionally) Pipe data to piche with a custom name:

```bash
echo hello world | npx piche -n="hello.txt"
```


## Why piche?

- The files are all hosted locally. Your data pipe through localtunnel temporarily. Once piche is shutdown, your data remains on your local machine.
- When you want to quickly share some log that carry sensitive data (which you shouldn't in the first place) and disable it right away after recipent has received it.

## Install globally

```bash
$ npm install -g piche
```

## CLI

```
$ piche --help
piche

UwU A localtunnel based pipe tool to share text quickly from terminal.

Options:
  --help       Show help                                               [boolean]
  --version    Show version number                                     [boolean]
  --start, -s  Start piche server                     [boolean] [default: false]
  --tmp, -t    Use os.tmpdir/.piche instead of os.homedir/.piche
                                                      [boolean] [default: false]
  --clean, -c  Cleanup os.tmpdir/.piche and os.homedir/.piche
                                                      [boolean] [default: false]
  --name, -n   Name of the output file, default: an uuid/v1             [string]
```

## Development

There are 2 available commands:

- `npm run dev` - Start development mode and recompile on change
- `npm run build` - Build a final distributable for npm

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