# msee

> Msee is a command-line tool to read Markdown file in your terminal, and it's a library help your command-line software to output readable markdown content.

Latest version **0.3.5** (published 2018-02-19) · MIT license · 0 weekly downloads

## Install

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

Provides the command `msee`.

## 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.3.5 |
| Published | 2018-02-19 |
| First published | 2013-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 44.8 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 95 |
| Author | Firede |
| Maintainers | firede, leichtgewicht |
| Keywords | markdown, terminal, reader, console, shell, colors, highlight |

## Links

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

## Dependencies (14)

- [nopt](https://npm.io/package/nopt.md) ^4.0.1
- [chalk](https://npm.io/package/chalk.md) ^2.3.1
- [xtend](https://npm.io/package/xtend.md) ^4.0.0
- [marked](https://npm.io/package/marked.md) 0.3.12
- [cardinal](https://npm.io/package/cardinal.md) ^1.0.0
- [entities](https://npm.io/package/entities.md) ^1.1.1
- [through2](https://npm.io/package/through2.md) ^2.0.3
- [wcstring](https://npm.io/package/wcstring.md) ^2.1.0
- [ansi-regex](https://npm.io/package/ansi-regex.md) ^3.0.0
- [ansicolors](https://npm.io/package/ansicolors.md) ^0.3.2
- [strip-ansi](https://npm.io/package/strip-ansi.md) ^4.0.0
- [text-table](https://npm.io/package/text-table.md) ^0.2.0
- [table-header](https://npm.io/package/table-header.md) ^0.2.2
- [combined-stream-wait-for-it](https://npm.io/package/combined-stream-wait-for-it.md) ^1.1.0

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 0.3.5 (latest) — 2018-02-19
- 0.3.4 — 2018-02-19
- 0.3.3 — 2017-02-19
- 0.3.2 — 2016-05-22
- 0.3.1 — 2016-01-31
- 0.3.0 — 2016-01-31
- 0.2.0 — 2015-11-03
- 0.1.2 — 2015-10-14
- 0.1.1 — 2014-01-10
- 0.1.0 — 2013-11-18
- 0.1.0-alpha.3 — 2013-05-24
- 0.1.0-alpha.2 — 2013-05-24
- 0.1.0-alpha.1 — 2013-05-24

## README

msee
===

[![NPM version](https://img.shields.io/npm/v/msee.svg?style=flat-square)](https://npmjs.org/package/msee)
[![Travis](https://img.shields.io/travis/firede/msee/master.svg?style=flat-square)](https://travis-ci.org/firede/msee)
[![Coveralls branch](https://img.shields.io/coveralls/firede/msee/master.svg?style=flat-square)](https://coveralls.io/github/firede/msee?branch=master)
[![Dependencies Status](https://img.shields.io/david/firede/msee.svg?style=flat-square)](https://david-dm.org/firede/msee)
[![download per month](https://img.shields.io/npm/dm/msee.svg?style=flat-square)](https://npmjs.org/package/msee)
[![License](https://img.shields.io/npm/l/msee.svg?style=flat-square)](https://npmjs.org/package/msee)

*msee* is a command-line tool to read markdown file.

And it's a library help your command-line software to output readable markdown content.

## Screenshot

<img width="752" alt="msee" src="https://cloud.githubusercontent.com/assets/157338/10902801/531ba216-823d-11e5-87ac-986b8d5ea4cc.png">

## Installation

    $ npm install -g msee

## Usage

    msee <file>
    msee <file> | less
    cat <file> | msee

## API

```javascript
var msee = require('msee');

// parse markdown text
msee.parse('> hello world!');

// parse markdown file
msee.parseFile('~/doc/readme.md');
```

## Contributors

https://github.com/firede/msee/graphs/contributors

## License

MIT &copy; [Firede](https://github.com/firede)

---

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/firede/msee/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

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