# plunk

> Utility to submit a directory to plnkr.co

Latest version **0.6.0** (published 2019-12-28) · MIT license · 0 weekly downloads

## Install

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

Provides the command `plunk`.

## 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.6.0 |
| Published | 2019-12-28 |
| First published | 2014-06-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 11 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 19 |
| Author | Ilya Kantor |
| Maintainers | iliakan |

## Links

- npm: https://www.npmjs.com/package/plunk
- Repository: https://github.com/iliakan/plunk
- Homepage: https://github.com/iliakan/plunk#readme
- Issues: https://github.com/iliakan/plunk/issues
- npm.io page: https://npm.io/package/plunk

## Dependencies (11)

- [co](https://npm.io/package/co.md) *
- [glob](https://npm.io/package/glob.md) *
- [mime](https://npm.io/package/mime.md) *
- [chalk](https://npm.io/package/chalk.md) *
- [nconf](https://npm.io/package/nconf.md) *
- [yargs](https://npm.io/package/yargs.md) *
- [lodash](https://npm.io/package/lodash.md) *
- [request](https://npm.io/package/request.md) *
- [winston](https://npm.io/package/winston.md) ^2
- [home-dir](https://npm.io/package/home-dir.md) *
- [request-promise](https://npm.io/package/request-promise.md) *

## Recent versions

- 0.6.0 (latest) — 2019-12-28
- 0.5.1 — 2016-10-24
- 0.5.0 — 2016-10-24
- 0.4.0 — 2016-05-11
- 0.3.0 — 2016-01-10
- 0.2.1 — 2015-10-30
- 0.2.0 — 2015-10-28
- 0.1.9 — 2014-10-14
- 0.1.8 — 2014-06-18
- 0.1.7 — 2014-06-18
- 0.1.6 — 2014-06-18
- 0.1.5 — 2014-06-18
- 0.1.4 — 2014-06-18
- 0.1.3 — 2014-06-18
- 0.1.2 — 2014-06-18
- … 3 more at https://npm.io/package/plunk/versions

## README

A tiny utility to post current directory contents to http://plnkr.co/edit

## Anonymous Usage

1. Go the the dir you want to plunk.
2. Run `plunk`

Or `plunk --dir path/to/dir --desc "A string describing the plunk" --tags "comma,separated,tags"`.

## Authorized usage

To submit plunks under your user and to update them, you need to be authorized.

For that:

1. Sign in to http://plnkr.co with Github (button in the right-upper corner of <http://plnkr.co/>)
2. In browser developer console run: `document.cookie.match(/plnk_session=(\w+)/)[1]` to obtain the session id.
3. Create `~/.plunk_config.json` with the content `{ "auth": { "id": "..." } }`, where `...` means the output of step 2.

This will save an authorized session which the utility will use.

An example of `~/.plunk_config.json`:
```
{
  "auth": { "id": "56224aba860eabcdef869189" }
}
```

## Exclusions

- Ignores files starting with a dot `'.'`

## Gotchas

- Saves current plunk metadata in the file `.plunk`, uses it to update the plunk properly.
- A once-created plunk is bound to its directory name. When you copy it into a new directory (or rename), `plunk` will create a brand-new plunk.
I found this behavior helpful, because when I clone an existing directory into a new example, it makes me sure I will not overwrite an existing plunk.
- The `--tags` flag only works when creating a new plunk, not updating an existing one.
- You should create .plunk_config.json in your home-dir, for details see https://www.npmjs.com/package/home-dir

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