https://github.com/temando/scavenger-scent-npm

A Scavenger scent for discovering NPM repositories from users.
https://github.com/temando/scavenger-scent-npm

Last synced: about 2 months ago
JSON representation

A Scavenger scent for discovering NPM repositories from users.

• Host: GitHub
• URL: https://github.com/temando/scavenger-scent-npm
• Owner: temando
• License: mit
• Created: 2018-01-16T04:42:16.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-17T01:26:44.000Z (almost 7 years ago)
• Last Synced: 2024-10-10T18:06:39.245Z (2 months ago)
• Language: TypeScript
• Size: 41 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NPM Scent

[![NPM](https://img.shields.io/npm/v/scavenger-scent-npm.svg)](https://npmjs.org/packages/scavenger-scent-npm/)

[![Travis CI](https://img.shields.io/travis/temando/scavenger-scent-npm.svg)](https://travis-ci.org/temando/scavenger-scent-npm)

[![MIT License](https://img.shields.io/github/license/temando/scavenger-scent-npm.svg)](https://en.wikipedia.org/wiki/MIT_License)

A scent for [Scavenger](https://github.com/temando/scavenger-cli)'s `scout` command, which retrieves project information from NPM.

## Installation

```sh

$ npm install -g scavenger scavenger-scent-npm

```

## Using NPM Scent

This scent is usually invoked from Scavenger's `scout` command:

```bash

$ scavenger scout npm  [keywords]

```

- `` Your NPM username, or team name.

- `[keywords]` Filter projects against their `package.json` `keywords` property. Specify multiple keywords with a comma.

This scent will retrieve details of projects the specified username has access to in NPM. The `scout` command is responsible for writing these details into a format that can be used by other `scavenger` commands such as `fetch` or `thieve`.