https://github.com/grimmbraten/spinning-jenny

A cli assistant that helps you resolve those pesky node module security vulnerabilities
https://github.com/grimmbraten/spinning-jenny

audit cli package-json patches resolutions terminal vulnerabilities yarn

Last synced: 6 days ago
JSON representation

A cli assistant that helps you resolve those pesky node module security vulnerabilities

• Host: GitHub
• URL: https://github.com/grimmbraten/spinning-jenny
• Owner: grimmbraten
• License: mit
• Created: 2021-06-18T11:29:52.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-04-05T06:41:20.000Z (over 1 year ago)
• Last Synced: 2024-10-03T06:40:11.403Z (about 1 month ago)
• Topics: audit, cli, package-json, patches, resolutions, terminal, vulnerabilities, yarn
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/spinning-jenny
• Size: 16.7 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


A cli assistant that helps you resolve those pesky node module security vulnerabilities

## Install

[![Source Quality Assurance](https://github.com/grimmbraten/spinning-jenny/actions/workflows/integrate.yml/badge.svg)](https://github.com/grimmbraten/spinning-jenny/actions/workflows/integrate.yml)

![npm](https://img.shields.io/npm/dt/spinning-jenny?logo=npm&style=social)

![GitHub Repo stars](https://img.shields.io/github/stars/grimmbraten/spinning-jenny?style=social)

```bash

yarn global add spinning-jenny

```

```bash

npm install -g spinning-jenny

```

## Upgrade

![npm](https://img.shields.io/npm/v/spinning-jenny?style=flat&color=gray)

![npms.io (maintenance)](https://img.shields.io/npms-io/maintenance-score/spinning-jenny?style=flat&color=gray)

![GitHub last commit](https://img.shields.io/github/last-commit/grimmbraten/spinning-jenny?style=flat&color=gray)

```bash

yarn global upgrade spinning-jenny --latest

```

```bash

npm update -g spinning-jenny

```

For more information, please refer to the [npm](https://docs.npmjs.com/cli/v6/commands/npm-update) or [yarn](https://classic.yarnpkg.com/en/docs/cli/upgrade) documentation.

## Usage

### Template

```bash

spinning-jenny  |  [--flag(s)]

```

### Examples

```bash

spinning-jenny clean fix --upgrade false

```

```bash

spinning-jenny config --frozen false --backup true

```

### Actions

Name

Description

audit

find potential security vulnerabilities in your dependencies

clean

remove resolutions from package.json

fix

solve potential security vulnerabilities in your dependencies

install

install dependencies

advise

find published advisories for potential security vulnerabilities in your dependencies

restore

apply saved resolution backup from package.json

### Commands

Name

Description

alias

print aliases

config

print/manage configuration

help

open documentation

repository

print source code url

version

print installed version

### Flags

Name

Short

Description

--backup

-b

create resolution backup before first action

--directory

-d

explicit path to package.json file

--exclude

-e

exclue modules from being upgraded or resolved

--frozen

-f

prevent yarn.lock modifications

--label

-l

print action step counter prefix

--upgrade

-u

upgrade dependencies and development dependencies

## Uninstall

```bash

yarn global remove spinning-jenny

```

```bash

npm uninstall -g spinning-jenny

```