# lana-cli

> Lana! NPM scripts with better UX 🏓

Latest version **3.1.2** (published 2021-01-08) · MIT license · 0 weekly downloads

## Install

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

Provides the command `lana`.

## 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 | 3.1.2 |
| Published | 2021-01-08 |
| First published | 2017-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 19.7 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 49 |
| Author | Rafal Pastuszak |
| Maintainers | rafalpast |
| Keywords | lana, cli-app, cli, package, npm, json, markdown, docs, documentation, yarn, utils |

## Links

- npm: https://www.npmjs.com/package/lana-cli
- Repository: https://github.com/paprikka/lana-cli
- Homepage: https://github.com/paprikka/lana-cli#readme
- Issues: https://github.com/paprikka/lana-cli/issues
- npm.io page: https://npm.io/package/lana-cli

## Dependencies (6)

- [meow](https://npm.io/package/meow.md) ^3.7.0
- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [keypress](https://npm.io/package/keypress.md) ^0.2.1
- [markdown-it](https://npm.io/package/markdown-it.md) ^8.3.1
- [find-parent-dir](https://npm.io/package/find-parent-dir.md) ^0.3.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^2.1.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 3.1.2 (latest) — 2021-01-08
- 3.1.2-beta.1 (beta) — 2021-01-08
- 3.1.1 — 2021-01-08
- 3.1.0 — 2021-01-06
- 3.1.0-beta.1 — 2021-01-03
- 3.0.2-beta.1 — 2021-01-03
- 1.0.0-beta.1 — 2021-01-03
- 3.0.1 — 2017-04-18
- 3.0.0 — 2017-03-10
- 2.1.0 — 2017-03-09
- 2.0.3 — 2017-03-09
- 2.0.2 — 2017-03-08
- 2.0.1 — 2017-03-08
- 2.0.0 — 2017-03-08
- 1.0.0 — 2017-03-07

## README

# Lana! NPM scripts with better UX 🏓
![logo](site/logo.png)

## What?

Lana! provides a convenient, global API to browse and run NPM scripts in your projects.
Also, it makes managing your documentation easier by pulling out descriptions from your projects' README.md file.

![terminal](site/lana.gif)

## Why?

Do you happen to switch between your projects often and rely on reading package.json to look up the dev tasks? 
Well, I do. So give it a try. Your OCD will thank you.

## Why not?

There are many ways of tackling this issue, usually script names should be descriptive enough or one might say `package.json` is not the right place for that at all.

Normally, I'd agree with that, but it suits my workflow and might help you as well.

## Setup

> Supported Node.js version: `6.x.x` and higher

### Yarn
    $ yarn global add lana-cli

### NPM
    $ npm i -g lana-cli

## Usage

In a Javascript project with `package.json`, type:

    $ lana

You can share documentation between lana! and README.md by tagging content, like in this imaginary CMS (Cat Management System).

### Usage (documentation)

Add `<!--lana: NPM_TASK_NAME-->` at the end of a header or paragraph describing the task, and Lana will pick it up.

    #### Start a debug server <!--lana: start-->
        $ npm start

    #### Upload kittens <!--lana: upload-kittens-->
        $ npm run upload-kittens

    #### Download database for integration tests <!--lana: integration-db-download-->
        $ ./build/prepare_db.sh && npm run integration-db-download

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