# segugio

> CLI for easy npm/bower licence scanning

Latest version **1.2.1** (published 2016-02-19) · MIT license · 0 weekly downloads

## Install

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

Provides the command `segugio`.

## 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 | 1.2.1 |
| Published | 2016-02-19 |
| First published | 2016-02-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=5.0.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alessandro Bellini - ilmente |
| Maintainers | ilmente |

## Links

- npm: https://www.npmjs.com/package/segugio
- Repository: https://ilmente@github.com/ilmente/segugio
- Homepage: https://github.com/ilmente/segugio#readme
- Issues: https://github.com/ilmente/segugio/issues
- npm.io page: https://npm.io/package/segugio

## Dependencies (5)

- [ramda](https://npm.io/package/ramda.md) ^0.19.1
- [colors](https://npm.io/package/colors.md) ^1.1.2
- [globby](https://npm.io/package/globby.md) ^4.0.0
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [cli-spinner](https://npm.io/package/cli-spinner.md) ^0.2.4

## Recent versions

- 1.2.1 (latest) — 2016-02-19
- 1.2.0 — 2016-02-19
- 1.1.0 — 2016-02-19

## README

# segugio
This is a tool for scanning folders, collecting informations (**especially licenses**) about `npm`/`bower` 
modules and report them.

Let's say it is a FOSS scanner. At least, I'm using it this way... :)

## Setup
Install `segugio` s a global `node` module, it's recommended. Anyway, you can even use it programmatically inside a project.
```
$ npm install -g segugio
```

## How it works as CLI

`$ segugio report`
to create a report of all bundles (functional unit with a `package.json` or a `bower.json`).

`$ segugio export`
to export all the information in a json format.

`$ segugio test`
to test `segugio` functionality.

`$ segugio --help`
to print out the CLI help.

#### Tip:
`$ segugio export > filename.json`
exports a json file.

## How it works programmatically
``` js
let segugio = require('segugio');

segugio.scan().then(results => {
	// do whatever you want with information
}, error => {
	// manage the error
});
```

--- 


That's all, folks!

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