# @mountbuild/mouse

> Gathering up all the power into one tool.

Latest version **0.2.2** (published 2020-09-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @mountbuild/mouse
pnpm add @mountbuild/mouse
yarn add @mountbuild/mouse
bun add @mountbuild/mouse
```

Provides the command `mouse`.

## 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.2.2 |
| Published | 2020-09-25 |
| First published | 2020-07-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 27 |
| Unpacked size | 346.7 KB |
| Known vulnerabilities | 0 (+6 in 2 direct dependencies) |
| Install scripts | no |
| Author | Lance Pollard |
| Maintainers | lancejpollard |
| Keywords | cli |

## Links

- npm: https://www.npmjs.com/package/@mountbuild/mouse
- Repository: https://github.com/mountbuild/mouse
- Homepage: https://github.com/mountbuild/mouse#readme
- Issues: https://github.com/mountbuild/mouse/issues
- Funding: https://github.com/sponsors/mountbuild
- npm.io page: https://npm.io/package/@mountbuild/mouse

## Dependencies (27)

- [gm](https://npm.io/package/gm.md) ^1.23.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [ngrok](https://npm.io/package/ngrok.md) ^3.2.7
- [sharp](https://npm.io/package/sharp.md) ^0.25.4
- [unrar](https://npm.io/package/unrar.md) ^0.2.0
- [which](https://npm.io/package/which.md) ^2.0.2
- [bcrypt](https://npm.io/package/bcrypt.md) ^5.0.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4
- [blessed](https://npm.io/package/blessed.md) ^0.1.81
- [jpeg-js](https://npm.io/package/jpeg-js.md) >=0.4.0
- [pdf-lib](https://npm.io/package/pdf-lib.md) ^1.9.0
- [archiver](https://npm.io/package/archiver.md) ^5.0.0
- [piexifjs](https://npm.io/package/piexifjs.md) ^1.0.6
- [fast-glob](https://npm.io/package/fast-glob.md) ^3.2.4
- [public-ip](https://npm.io/package/public-ip.md) ^4.0.2
- [svgexport](https://npm.io/package/svgexport.md) ^0.4.0
- [ttf2woff2](https://npm.io/package/ttf2woff2.md) ^3.0.0
- [image-size](https://npm.io/package/image-size.md) ^0.8.3
- [node-forge](https://npm.io/package/node-forge.md) >=0.10.0
- [node-latex](https://npm.io/package/node-latex.md) ^3.0.0
- [localtunnel](https://npm.io/package/localtunnel.md) ^2.0.0
- [ansi-escapes](https://npm.io/package/ansi-escapes.md) ^4.3.1
- [asciify-image](https://npm.io/package/asciify-image.md) ^0.1.6
- [git-user-email](https://npm.io/package/git-user-email.md) ^0.2.2
- [probe-image-size](https://npm.io/package/probe-image-size.md) ^5.0.0
- [libreoffice-convert](https://npm.io/package/libreoffice-convert.md) ^1.1.1
- [@google-cloud/storage](https://npm.io/package/@google-cloud/storage.md) ^5.1.2

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2020-09-25
- 0.2.1 — 2020-09-10
- 0.2.0 — 2020-07-24

## README

<br/>
<br/>
<br/>
<br/>
<br/>
<br/>
<br/>

<p align='center'>
  <img src='https://github.com/mountbuild/mouse/blob/build/slate/house.gif?raw=true' width='192'/>
</p>

<br/>

<h3 align='center'>mouse</h3>
<p align='center'>
  Common Actions in a Simplified Interface
</p>

<p align='center'>
  अहमादिश्च मध्यं च भूतानामन्त एव च
</p>

<br/>
<br/>

<p align='center'>
  <a href='#summary'>Summary</a> •
  <a href='#getting-started'>Getting Started</a> •
  <a href='#cli'>CLI</a> •
  <a href='#contribute'>Contribute</a> •
  <a href='#license'>License</a>
</p>

<p align='center'>
  <img src='https://github.com/mountbuild/mouse/workflows/build/badge.svg?branch=build' />
</p>

<br/>
<br/>
<br/>

### Summary

The Mouse is a collections of common actions to perform in code. It provides an API and CLI for performing these actions.

### Getting Started

Requirements on Mac

```bash
brew cask install java
brew cask install mactex
brew cask install libreoffice
brew install imagemagick
brew install fontforge
brew install ffmpeg
brew install node
```

Requirements for Windows:

```
choco install libreoffice-fresh
choco install imagemagick --version 7.0.10.19
choco install fontforge
choco install ffmpeg
choco install miktex
choco install nodejs
```

Requirements for Linux:

```
sudo apt-get update
sudo apt-get install build-essential
sudo apt-get install texlive-xetex
sudo apt-get install imagemagick
sudo apt-get install libreoffice
sudo apt-get install fontforge
sudo apt-get install inkscape
sudo apt-get install ffmpeg
sudo apt-get install ufraw
sudo apt-get install rar
```

Finally, with these dependencies installed, you can install the mouse:

```
npm install -g @mountbuild/mouse
```

### CLI

Here are some helpful commands to get you started:

#### Split a PDF into individual files.

```
$ mouse split some.pdf -o outputDirectory
```

#### Take a subset of a PDF.

```
$ mouse slice some.pdf -s 15 -e 25 -o output.pdf
```

#### Rename recursively a bunch of files:

```
$ mouse rename -t f -p "tmp/**/*.jpg" -s "\.jpg" -e ".png"
```

#### Convert HTML to PDF

```
$ mouse convert tmp/index.html -o tmp/index.pdf -w 2000px -h 3000px
```

#### Remove All EXIF Data from a JPEG

```
$ mouse remove exif input.jpg
```

#### Resize Image


```
$ mouse resize input.jpg -w 300 -o output.jpg
```

### Contribute

Contributions are greatly welcomed. Help us define what the ideal interface would be for a browser-terminal-editor-os app. Identify the key painpoints in the customer onboarding flow, and help us map out the best solutions. See the [contributor's guide](https://github.com/mountbuild/mouse/blob/build/slate/contributing.md) for more info if you are just starting out coding. And here is a list of the contributors, just one atm.

<br/>
<br/>
<br/>

<p align='center'>
  <!-- https://api.github.com/users/lancejpollard -->
  <a href='https://github.com/lancejpollard'>
    <img alt='lancejpollard' src='https://avatars0.githubusercontent.com/u/28718?v=4&s=117' width='117' />
  </a>
</p>

<br/>
<br/>
<br/>

Also, [track our release progress](https://github.com/mountbuild/mouse/blob/build/slate/changelog.md) if you're interested!

### License

Copyright 2020 <a href='https://mount.build'>Mount</a>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

### Mount

Mouse is being developed by the folks at [Mount](https://mount.build), a California-based project for helping humanity master information and computation. Mount started off in the winter of 2008 as a spark of an idea, to forming a company 10 years later in the winter of 2018, to a seed of a project just beginning its development phases. Mount funds mouse's development. It is entirely bootstrapped by working full time and running [Etsy](https://etsy.com/shop/mountbuild) and [Amazon](https://www.amazon.com/s?rh=p_27%3AMount+Build) shops. Also find us on [Facebook](https://www.facebook.com/mountbuild), [Twitter](https://twitter.com/mountbuild), and [LinkedIn](https://www.linkedin.com/company/mountbuild). Check out our other GitHub projects as well!

<br/>

<p align='center'>
  <a href='https://github.com/mountbuild/wheel'>
    <img src='https://github.com/mountbuild/wheel/blob/build/slate/world.gif?raw=true' width='64'/>
  </a>
  <a href='https://github.com/mountbuild/bloom'>
    <img src='https://github.com/mountbuild/bloom/blob/build/slate/house.gif?raw=true' width='224'/>
  </a>
  <a href='https://github.com/mountbuild/stone'>
    <img src='https://github.com/mountbuild/stone/blob/build/slate/world.gif?raw=true' width='128'/>
  </a>　　
  <a href='https://github.com/mountbuild/mouse'>
    <img src='https://github.com/mountbuild/mouse/blob/build/slate/world.gif?raw=true' width='128'/>
  </a>　　
  <a href='https://github.com/mountbuild/flame'>
    <img src='https://github.com/mountbuild/flame/blob/build/slate/world.gif?raw=true' width='128'/>
  </a>
</p>

<br/>

<p align='center'>
  <em>The Mouse has connections that truly inspire,<br/>
  Tunneling underground, providing protection, avoiding fire.<br/>
  Moving swiftly through the night, through the Brush and Stick.<br/>
  Gathering vegetation, helping others, they are swift.<br/>
  Adapting to every environment, they are key to the network of the forest.</em>
</p>

<br/>
<br/>

<p align='center'>
  <a href='https://twitter.com/mountbuild'>
    <img src='https://mount.build/slate/twitter.png' height='64' />
  </a>　　　　
  <a href='https://etsy.com/shop/mountbuild'>
    <img src='https://mount.build/slate/etsy.png' height='64' />
  </a>　　　　
  <a href='https://github.com/mountbuild'>
    <img src='https://mount.build/slate/github.png' height='64' />
  </a>　　　
  <a href='https://www.amazon.com/s?rh=p_27%3AMount+Build'>
    <img src='https://mount.build/slate/amazon.png' height='64' />
  </a>　　　
  <a href='https://www.facebook.com/mountbuild'>
    <img src='https://mount.build/slate/facebook.png' height='64' />
  </a>
</p>

<br/>
<br/>

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