UNPKG

2.12 kBMarkdownView Raw
1<p align="center"><img src="media/emma.png" width="800" /></p>
2
3# Emma 📦
4
5[![CircleCI](https://circleci.com/gh/maticzav/emma-cli.svg?style=shield)](https://circleci.com/gh/maticzav/emma-cli)
6[![npm version](https://badge.fury.io/js/emma-cli.svg)](https://badge.fury.io/js/emma-cli)
7[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
8
9> Install the package you are looking for.
10
11Power by Algolia and Yarn.
12
13<p align="center"><img src="media/example.gif" width="800" /></p>
14
15## Overview
16
17Emma is a command line assistant which helps you search and install packages more quickly. Using the power of Algolia it is extremely responsive and gives you all the information you need to decide which package is the right one.
18
19## Features
20
21- __Extremely fast:__ Search all the packages from NPM and Yarn using your terminal.
22- __Build the stack:__ Search for multiple packages and install them with one keystroke.
23- __Automatic tool detection:__ Detects whether it should use Yarn or NPM, out of the box.
24
25## Install
26
27```bash
28npm install -g emma-cli
29```
30
31Use Yarn or NPM to install.
32
33## Example
34
35```bash
36❯ emma-cli ~ emma
37Search packages 📦 : graphql
38❯ 2m graphql graphql A Query Language and Runtime which can target any service.
39 176 graph.ql MatthewMueller Faster and simpler technique for creating and querying Grap
40 971.6k @types/graphql DefinitelyTyped TypeScript definitions for graphql
41 950.5k graphql-tag apollostack A JavaScript template literal tag that parses GraphQL queri
42 790.2k graphql-anywhere apollographql Run GraphQL queries with no schema and just one resolver
43
44Picked:
45› ava 0.25.0
46```
47
48## API
49
50```md
51Usage
52 $ emma
53
54Example
55 $ emma -D
56
57Options
58 --dev -D Add to dev dependencies.
59
60Run without package-name to enter live search.
61Use keyboard to search through package library.
62Use up/down to select packages.
63Click enter to trigger the install.
64```
65
66## License
67
68MIT © [Matic Zavadlal](https://github.com/maticzav)
69
70<p align="center"><img src="media/algolia.svg" width="400" /></p>